Discover the exposed record types

​

Every record type this API serves, with its path segment and the filters, sort keys and expansions its routes accept — the same information as the OpenAPI document, in one call.

Headers
  • X-Api-Key
    Type: string · X-Api-Keynullable
Responses
  • application/json
  • 401

    Missing or invalid X-Api-Key (CAPI11).

  • application/json
Request Example for get/v1/types
curl /v1/types \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN'

{
  "types": [
    {
      "name": "string",
      "segment": "string",
      "filterable_fields": [
        "string"
      ],
      "sortable_fields": [
        "string"
      ],
      "expandable_links": [
        "string"
      ],
      "has_status": true,
      "status_values": [
        "string"
      ]
    }
  ],
  "segment_rule": "string"
}

Successful Response