PARSERGet Started

PARSER GUIDES

List Classifiers

GET

/api/v1/classifiers

List document classifiers available to the API key's team. Parser schema, fields, exports, and review settings are not included.

Authorization

bearerAuth

authorization: <token>

Your API key. Include it directly in the Authorization header as the API key value (e.g., 'authorization: your-api-key-here')

In: header

Response Body

200

application/json

curl -X GET "https://api.PARSER.com/api/v1/classifiers"

200

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Claims intake",
      "description": "string",
      "isActive": true,
      "emailAddress": "contact@parser.example",
      "acceptedFileTypes": [
        {
          "mimeType": "application/pdf",
          "label": "PDF"
        }
      ],
      "settings": {
        "routing": {
          "rules": [
            {
              "id": "string",
              "label": "Invoice",
              "targetParserId": "c1414b5c-cc7f-4042-9bc2-fa9363157ee6"
            }
          ],
          "fallback": {
            "action": "skip",
            "targetParserId": "c1414b5c-cc7f-4042-9bc2-fa9363157ee6"
          },
          "instructions": "string"
        },
        "splitDocuments": {
          "enabled": true,
          "mode": "everyXPages",
          "everyXPages": 5,
          "pageRanges": "1, 3, 7-9",
          "instructions": "Each invoice starts with an invoice number at the top.",
          "partitionKey": "transactions.transaction_date",
          "partitionKeySource": "parserField"
        }
      },
      "counts": {
        "totalDocuments": 0,
        "routed": 0,
        "skipped": 0,
        "failed": 0
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
Delete Documents POSTDelete documents so their \externalId\ values can be reused on re-upload. \*\*Request body:\*\* Provide \documentIds\ and/or \externalIds\. - If you send \documentIds\, \externalIds\ is optional. - If you send \externalIds\, \documentIds\ is optional. - You must provide at least one of them.Open guide → Create Classifier POSTCreate a document classifier with at least one routing rule. Classifiers route documents to parsers and do not define extraction fields.Open guide →