cURL
curl --request GET \ --url https://api.kadoa.com/v4/schemas/{schemaId} \ --header 'x-api-key: <api-key>'
{ "error": false, "data": { "id": "<string>", "name": "<string>", "isPublic": true, "schema": [ { "name": "<string>", "description": "<string>", "dataType": "STRING", "fieldType": "SCHEMA", "example": "<string>", "isKey": true } ], "entity": "<string>", "description": { "hintText": "<string>" } } }
Retrieve a specific schema by its unique identifier
API key for authentication
Schema ID
200
Response wrapper for a single schema
Error flag (always false on success)
true
false
Schema data
Show child attributes
Unique identifier for the schema
Name of the schema
Whether the schema is public
Array of field definitions
Extraction field schema
Field name (letters and numbers only)
Field description
1
Data type of the field
STRING
NUMBER
BOOLEAN
DATE
DATETIME
MONEY
IMAGE
LINK
OBJECT
ARRAY
SCHEMA
Example value for the field
Whether the field is a key field
Entity type for the schema
Schema description metadata
Hint text for the schema