Get Schema

GET /schema

Returns the types and fields you can use in filter on list endpoints. Field name values match the fieldName you pass in a filter. Museum custom customer fields appear on the CUSTOMER type as UUID field names.

Use this together with Querying.

Example Response


Copy
{
  "entries": [
    "CUSTOMER",
    "MEMBERSHIP",
    "EMAIL",
    "TICKET",
    "EVENT_TICKET",
    "GIFTCARD",
    "VISIT"
  ],
  "types": [
    {
      "name": "CUSTOMER",
      "fields": [
        {
          "name": "EMAIL",
          "type": "TEXT",
          "prettyName": "Email"
        }
      ]
    }
  ]
}

Property	Type	Description
`entries`	array	Type names that can appear as list resources
`types`	array	Filterable types for this museum
`types[].name`	string	Type name (for example `CUSTOMER`, `MEMBERSHIP`)
`types[].fields`	array	Fields you can put in `fieldName`
`types[].fields[].name`	string	Filter field name
`types[].fields[].type`	string	Field type (for example `TEXT`, `DATE`, `BOOLEAN`, `REFERENCE`)
`types[].fields[].prettyName`	string	Human-readable label

Fields marked hidden in the filter overview are omitted. Custom customer fields are included on CUSTOMER when the museum has them.