Read record types and their configuration

Returns the configuration revision with the fields, stable select option ids, relationships, relationship paths and capabilities of the requested types, or of every accessible type when typeIds is omitted. Access presets are included only for schema and role managers. Pass the smallest set of typeIds you need, and send revision as expectedRevision on record and configuration writes.

Requires: read access to the list; data-model and role managers see every list and its access presets.

POST
/v1/model/read

Authorization

apiKeyAuth
x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://customermates.com/api/v1/model/read" \  -H "Content-Type: application/json" \  -d '{}'
{
  "revision": 9007199254740991,
  "types": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "label": "string",
      "pluralLabel": "string",
      "description": "string",
      "icon": "string",
      "color": "default",
      "primaryFieldId": "764026b0-e599-4f21-b381-59306bbaefa6",
      "parentRelationshipId": null,
      "embedded": true,
      "navigationVisible": true,
      "archived": true,
      "position": 9007199254740991,
      "relationshipPaths": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "label": "string",
          "path": [
            {
              "relationId": "4b4bc808-5132-481f-afc2-e3872bf12049",
              "direction": "outgoing"
            }
          ],
          "archived": true
        }
      ]
    }
  ],
  "fields": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
      "label": "string",
      "valueType": "text",
      "behavior": {
        "kind": "input",
        "defaultValue": {
          "kind": "text",
          "value": "string"
        }
      },
      "required": true,
      "multiple": true,
      "format": {
        "color": "string",
        "dateFormat": "string",
        "currency": "string",
        "decimalPlaces": 30,
        "onClick": "open",
        "providerAvatar": true
      },
      "archived": true,
      "publishedSummary": true,
      "options": [
        {
          "id": "string",
          "label": "string",
          "color": "string",
          "attributes": [
            {
              "key": "string",
              "value": {
                "kind": "text",
                "value": "string"
              }
            }
          ]
        }
      ],
      "position": 9007199254740991
    }
  ],
  "relationships": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "sourceTypeId": "a5fe7750-b892-4da9-b879-6c18a56c9c68",
      "targetTypeId": "099a21b0-6d6a-4acf-bf0d-c60d38f08ee6",
      "sourceLabel": "string",
      "targetLabel": "string",
      "sourceCardinality": "one",
      "targetCardinality": "one",
      "onSourceDelete": "unlink",
      "onTargetDelete": "unlink",
      "messagesOnSource": true,
      "messagesOnTarget": true,
      "archived": true
    }
  ],
  "accessPresets": [],
  "capabilities": []
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
Empty