# Get all file formats

Endpoint: GET /file-formats
Version: 5.1.51
Security: api_key

## Security:

  - `api_key` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `page_number` (integer)
    The page number for which to get file formats. 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 property if not provided

## Response 200:

  - `200` (unknown)
    Success

## 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)

  - `responseList.fileFormatId` (integer)
    The ID number of the file format. This field is auto-generated by the Masking Engine.

  - `responseList.fileFormatName` (string)
    The name of the file format, as inferred from the uploaded file.

  - `responseList.fileFormatType` (string)
    The type of file that this file format describes.
    Enum: "DELIMITED", "FIXED_WIDTH", "XML", "JSON", "PARQUET"

  - `responseList.header` (integer)
    The number of lines at the beginning of the file to skip.

  - `responseList.footer` (integer)
    The number of lines at the end of the file to skip.

  - `responseList.wholeFileMasking` (boolean)
    This flag indicates if the file format is associated with a file to be read as whole or line-by-line (Only for FIXED_WIDTH file type). For example, if the whole file masking is true, then the whole file will be read as a single record, rather than reading it line by line.

  - `responseList.fieldsCount` (integer)
    This returns the number of fields present in a file format.

  - `responseList.fileFormatDownloadId` (string)
    The ID of the file format download. This is used to download the file format.

## Response 403:

  - `403` (unknown)
    Forbidden access