Get Entity

GET

entities

{id}

Get Entity

curl --request GET \
  --url https://public.api.serval.com/v2/entities/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "number": 123,
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "document": "<string>",
    "entityTypeKey": "<string>",
    "entitySchemaKey": "<string>",
    "entitySchemaId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

The ID of the entity.

Response

Success

data

data · object

The entity.

Show child attributes

data.id

string

The ID of the entity.

data.teamId

string

The ID of the team that the entity belongs to.

data.entityTypeId

string

The ID of the entity type.

data.key

string

The unique key for the entity within its type.

data.name

string

The name of the entity.

data.number

integer<int32>

The sequential number for the entity within the team.

data.createdByUserId

string

The ID of the user who created the entity.

data.updatedByUserId

string

The ID of the user who last updated the entity.

data.createdAt

string<date-time>

The timestamp when the entity was created.

data.updatedAt

string<date-time>

The timestamp when the entity was last updated.

data.document

string

The entity's document data as a JSON string.

data.entityTypeKey

string

The key of the entity type.

data.entitySchemaKey

string

The key of the entity schema.

data.entitySchemaId

string

The ID of the entity schema.

Update EntityUpdate an existing entity.

⌘I

Get Entity

curl --request GET \
  --url https://public.api.serval.com/v2/entities/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "number": 123,
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "document": "<string>",
    "entityTypeKey": "<string>",
    "entitySchemaKey": "<string>",
    "entitySchemaId": "<string>"
  }
}

Authentication

Endpoints

Development

Authorizations

Path Parameters

Response