# Get all algorithms

Endpoint: GET /algorithms
Version: 5.1.45
Security: api_key

## Query parameters:

  - `mask_type` (string)
    The data type of value this algorithm can mask.
    Enum: "BIG_DECIMAL", "LOCAL_DATE_TIME", "STRING", "BYTE_BUFFER", "GENERIC_DATA_ROW"

  - `page_number` (integer)
    The page number for which to get algorithms. This will default to the first page if excluded

  - `page_size` (integer)
    The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

## Response 200 fields (application/json):

  - `_pageInfo` (object)

  - `_pageInfo.numberOnPage` (integer)
    The number of items on this page. This should always match the page size unless it is the last page.

  - `_pageInfo.total` (integer)
    The total number of items

  - `responseList` (array)
    Example: [{"algorithmName":"SimpleMaskingAlgorithm","algorithmType":"COMPONENT","description":"This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine.","pluginId":7,"frameworkId":3,"algorithmExtension":{"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}}}]

  - `responseList.algorithmName` (string, required)
    Equivalent to the algorithm name saved by the user through the GUI. For out of the box algo, this represents algorithm code.
    Example: "SimpleMaskingAlgorithm"

  - `responseList.legacyName` (string)
    This represents algorithm name shown on the UI.

  - `responseList.algorithmType` (string, required)
    The type of algorithm
    Enum: "BINARY_LOOKUP", "CLEANSING", "COMPONENT", "CUSTOM_ALGORITHM", "DATE", "LOOKUP", "MAPPING", "MINMAX", "MISC", "REDACTION", "SEGMENT", "TOKENIZATION"

  - `responseList.canReturnNull` (boolean)
    Whether or not the algorithm can return null values

  - `responseList.createdBy` (string)
    The name of the user that created the algorithm

  - `responseList.description` (string)
    The description of the algorithm
    Example: "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine."

  - `responseList.maskType` (string)
    The masking type of the algorithm

  - `responseList.isTokenizationSupported` (boolean)
    Whether or not the algorithm can be used with tokenization and reidentification job

  - `responseList.frameworkId` (integer)
    The algorithm framework id
    Example: 3

  - `responseList.frameworkName` (string)
    The algorithm framework name

  - `responseList.jsonConfigurable` (boolean)
    The algorithm is json Configurable or not.

  - `responseList.pluginId` (integer)
    The id, if applicable, of the plugin that supplies this algorithm or the framework this algorithm is built on
    Example: 7

  - `responseList.fields` (array)

  - `responseList.fields.fieldId` (integer)
    The id of the algorithm field.

  - `responseList.fields.name` (string)
    The name of the algorithm field.

  - `responseList.fields.type` (string)
    The type of value this algorithm field.
    Enum: "BIG_DECIMAL", "LOCAL_DATE_TIME", "STRING", "BYTE_BUFFER"

  - `responseList.fields.isReadOnly` (boolean)
    Indicates whether the field is read-only. Read-only fields are taken as input by the masking algorithm but not masked.

  - `responseList.fields.isOptional` (boolean)
    Indicates whether the field is optional. Optional fields do not have to be assigned to a real data field or column in order for a masking assignment to be considered valid.

  - `responseList.fields.description` (string)
    The description of the algorithm field.

  - `responseList.algorithmExtension` (object)
    Example: {"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}}

  - `responseList.isConfigInvalid` (boolean)
    Whether or not the configuration in algorithmExtension is invalid


## Response 400 fields

## Response 403 fields