Schema

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

NameTypeRequiredDescription
template_idStringYesTemplate identifier
template_versionIntegerNoTemplate version. If not provided, the latest version is returned

Query string parameters

NameTypeRequiredDescription
schemaTypeStringNoSchema format — "eledo" (default), "zapier" or "integromat"

Response

Body

NameTypeDescription
schemaArray of schema itemsTemplate field structure

Schema item

NameTypeDescription
keyStringField identifier
typeStringField type (e.g. string, number)
childrenArray of schema itemsNested fields
listBooleanIndicates array field

When to use Schema

Use this endpoint to:

  • understand required input fields
  • construct the file payload for the Generate endpoint
  • dynamically build forms or integrations

Next steps


Was this article helpful?

Yes

No