Skip to main content
GET
/
v2
/
entity-type-fields
/
{id}
Get Entity Type Field
curl --request GET \
  --url https://public.api.serval.com/v2/entity-type-fields/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "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>"
  }
}

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 field.

Response

Success

​
data
data · object

The entity type field, including its enum options.