Docs
Get Schema
GET /documents/schema
GET
/documents/schemaRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder. |
Returns the full entity schema available for building QueryBlocks. This is the registry of all queryable entities, their properties, navigations, and owned sub-navigations.
Requires EventDocumentsEdit permission.
Response
Returns an array of SchemaEntity objects — one per base entity (11 total: Crew, Collaborator, Area, Activity, Advance, AdvanceRequest, AdvanceQuestion, ProcurementResource, File, Order, Task).
| Field | Type | Description |
|---|---|---|
| name | string | Entity identifier used in queries (e.g. `"Task"`). |
| label | string | Human-readable label (e.g. `"Task"`). |
| properties | array | Selectable/filterable properties. |
| navigations | array | Non-collection navigations (one-to-one). |
| collections | array | Collection navigations (one-to-many). |
| ownedSubNavigations | array | Inline owned objects (e.g. `BillingInformation`). |
Each SchemaProperty:
| Field | Type | Description |
|---|---|---|
| name | string | Property key used in query paths. |
| type | string | `string`, `bool`, `int`, `DateTime`, or `dynamic`. |
| isFilterable | bool | Whether this property can be used in filters. |
| isSortable | bool | Whether this property can be used for sorting. |
| isDynamicBag | bool | True for JSON bag properties (CustomAttributes, Properties, etc.) that carry event-specific keys. |