Skip to main content
GET
/
v2
/
entity-types
List Entity Types
curl --request GET \
  --url https://public.api.serval.com/v2/entity-types \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "teamId": "<string>",
      "key": "<string>",
      "name": "<string>",
      "parentEntityTypeId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "updatedByUserId": "<string>",
      "fields": [
        {
          "id": "<string>",
          "entityTypeId": "<string>",
          "key": "<string>",
          "name": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdByUserId": "<string>",
          "updatedByUserId": "<string>",
          "enumOptions": [
            {
              "id": "<string>",
              "value": "<string>",
              "displayName": "<string>",
              "displayOrder": 123
            }
          ],
          "isKeyField": true,
          "isNameField": true,
          "refEntityTypeId": "<string>",
          "description": "<string>",
          "sourceEntityTypeId": "<string>",
          "sectionId": "<string>"
        }
      ],
      "color": "<string>",
      "iconSlug": "<string>",
      "entitySchemaId": "<string>",
      "sections": [
        {
          "id": "<string>",
          "entityTypeId": "<string>",
          "name": "<string>",
          "sourceEntityTypeId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdByUserId": "<string>",
          "updatedByUserId": "<string>"
        }
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
teamId
string

The ID of the team.

​
pageSize
integer<int32>

Maximum number of results to return. Default is 5000, maximum is 10000.

​
pageToken
string

Token for pagination. Leave empty for the first request.

Response

Success

​
data
EntityTypeWithFields · object[]

The list of entity types.

​
nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results.