PerfectParser Docs

Get Parser

Reference for the GET /v1/parsers/:id endpoint.

GET /v1/parsers/:id

Retrieves the details of a single parser.

Path Parameters

ParameterTypeRequiredDescription
idstringThe unique ID of the parser to retrieve.
curl https://api.perfectparser.com/v1/parsers/prs_999 \
  -H "X-API-Key: pp_live_your_secret_key"

Response 200 OK

{
  "parser": {
    "parser_id": "prs_999",
    "name": "Invoice Parser",
    "description": "Extracts vendor and totals from invoices",
    "result_mode": "one_per_file",
    "schema": {
      "type": "object",
      "properties": {
        "invoice_number": { "type": "string" },
        "total_amount": { "type": "number" }
      }
    },
    "fields": {
      "invoice_number": { "description": "" },
      "total_amount": { "description": "" }
    },
    "has_sample_file": true,
    "sample_file_id": "smp_123",
    "created_at": "2026-06-20T10:00:00.000Z",
    "updated_at": "2026-06-20T10:00:42.000Z"
  }
}

Common Error Responses

HTTP StatusError CodeDescription
401UNAUTHORIZEDInvalid or missing API key.
404PARSER_NOT_FOUNDThe requested parser does not exist or belongs to another account.

On this page