Skip to main content
GET
/
v2
/
entity-types
/
{id}
Get Entity Type
curl --request GET \
  --url https://public.api.serval.com/v2/entity-types/{id} \
  --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>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "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>"
      }
    ],
    "color": "<string>",
    "iconSlug": "<string>",
    "entitySchemaId": "<string>",
    "helpAgentVisibility": "HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the entity type.

Response

Success

​
data
data · object

The entity type.