Skip to main content
GET
/
v2
/
entities
List Entities
curl --request GET \
  --url https://public.api.serval.com/v2/entities \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "number": 123,
      "teamId": "<string>",
      "teamPrefix": "<string>",
      "entityTypeId": "<string>",
      "entityTypeKey": "<string>",
      "createdByUserId": "<string>",
      "updatedByUserId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "fieldValues": [
        {
          "fieldId": "<string>",
          "fieldKey": "<string>",
          "fieldName": "<string>",
          "dataType": "DATA_TYPE_UNSPECIFIED",
          "value": 123,
          "setByUserId": "<string>",
          "setByIngestionConfigId": "<string>"
        }
      ],
      "sourceAppInstanceIds": [
        "<string>"
      ],
      "sharedMetadata": {
        "sourceTeamId": "<string>",
        "sourceTeamName": "<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.

​
entityTypeId
string

Optional filter by entity type ID.

​
pageSize
integer<int32>

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

​
pageToken
string

Token for pagination. Leave empty for the first request.

Response

Success

​
data
Entity · object[]

The list of entities.

​
nextPageToken
string | null

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