Schema
Returns a template schema that can be used to construct a valid input payload (file) for document generation.
- HTTP Method:
GET - Endpoint:
https://eledo.online/api/RESTv1/Schema/{template_id}/{template_version}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
template_id | String | Yes | Template identifier |
template_version | Integer | No | Template version. If not provided, the latest version is returned |
Query string parameters
| Name | Type | Required | Description |
|---|---|---|---|
schemaType | String | No | Schema format — "eledo" (default), "zapier" or "integromat" |
Response
Body
| Name | Type | Description |
|---|---|---|
schema | Array of schema items | Template field structure |
Schema item
| Name | Type | Description |
|---|---|---|
key | String | Field identifier |
type | String | Field type (e.g. string, number) |
children | Array of schema items | Nested fields |
list | Boolean | Indicates array field |
When to use Schema
Use this endpoint to:
- understand required input fields
- construct the
filepayload for the Generate endpoint - dynamically build forms or integrations
Next steps
- Generate document → Generate
Was this article helpful?
Yes
No