getDocumentType

Get a document type by ID

GET/api/document-types/{id}

Retrieve the full definition of a single document type by its ID, including its JSON Schema, prompt hints, and conversion settings.

Use this endpoint to inspect how a document type extracts data, or to export a type's configuration so you can recreate it elsewhere with POST /api/document-types or update it with PUT /api/document-types/{id}.

Access rules — the API key's user can read a document type when any of these hold:

The type is public and published (isPublic: true, status: PUBLISHED).
The user created the type.
The user is a member of the organization that owns the type.

If none apply, the endpoint responds with 404 (the existence of private types is never disclosed). Only public, reusable fields are returned — internal metadata such as the owning organization or creator is omitted.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token for API authentication

In: header

Path Parameters

id*string

Document type ID

Response Body

`application/json`

curl -X GET "https://app.docutray.com/api/document-types/string"

{
  "data": {
    "id": "clz9k2p1a0001s8m3xq7v4r2t",
    "codeType": "invoice",
    "name": "Invoice",
    "description": "Commercial invoice with supplier, totals and line items.",
    "isPublic": true,
    "isDraft": false,
    "status": "PUBLISHED",
    "jsonSchema": {
      "type": "object",
      "properties": {
        "invoice_number": {
          "type": "string"
        },
        "issue_date": {
          "type": "string",
          "format": "date"
        },
        "total_amount": {
          "type": "number"
        }
      },
      "required": [
        "invoice_number",
        "total_amount"
      ]
    },
    "promptHints": "Amounts are in the document's currency; keep two decimals.",
    "identifyPromptHints": null,
    "conversionMode": "json",
    "keepPropertyOrdering": true,
    "createdAt": "2024-07-15T10:23:00.000Z",
    "updatedAt": "2024-09-02T14:05:00.000Z"
  }
}

{
  "error": "Invalid document type ID"
}

{
  "error": "Invalid API key"
}

{
  "error": "Insufficient permissions"
}

{
  "error": "Document type not found"
}

{
  "error": "Rate limit exceeded"
}

{
  "error": "Error processing request"
}

getDocumentType

Get a document type by ID

Authorization

Path Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`