List Schemas
List every saved extraction schema in your organization with cursor pagination, case-insensitive name search, sort order, and per-schema field counts.
The GET /v1/schemas endpoint lists every saved extraction schema in your organization. A schema defines the target column shape you want extracted from documents: save it once, then reuse it across extractions by passing its id as schema_id so every run returns the same fields. The schema is the shape only; a Spec layers a rail, resolution policies, and validation gates on top of a schema for governed Pipeline runs.
Use this endpoint to browse your organization's schemas, search by name, and paginate through large collections. Each schema in the response includes its field count, its full JSON Schema definition, and links to related extractions.
/v1/schemasQuery parameters
20descList schemas matching "invoice"
curl -H "Authorization: Bearer $TALONIC_API_KEY" \
"https://api.talonic.com/v1/schemas?search=invoice&limit=20"Response
Response fields
Response
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"short_id": "SCH-A1B2C3D4",
"name": "Invoice",
"description": "Standard invoice extraction schema",
"definition": {
"type": "object",
"properties": {
"invoice_number": { "type": "string", "title": "invoice_number" },
"vendor": { "type": "string", "title": "vendor" },
"total": { "type": "number", "title": "total" },
"date": { "type": "date", "title": "date" }
},
"required": ["invoice_number"]
},
"field_count": 4,
"version": 1,
"created_at": "2024-08-20T14:00:00.000Z",
"updated_at": "2024-09-10T09:15:00.000Z",
"links": {
"self": "/v1/schemas/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"extractions": "/v1/extractions?schema_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"dashboard": "https://app.talonic.com/schemas/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
],
"pagination": {
"total": 12,
"limit": 20,
"has_more": false,
"next_cursor": null
}
}Errors
Error responses
Frequently asked questions
How do I search for a schema by name?+
search query parameter with a partial name string. The search is case-insensitive and matches any substring of the schema name.What is the maximum number of schemas I can retrieve in one request?+
limit up to 100 per request. Use the next_cursor value from the response to paginate through additional results.Does listing schemas include the full field definitions?+
definition with all field properties, types, and required markers.