Positions

List all positions viewable for API user

get

/positions

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/positions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "tagIDs": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/positions/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/positions/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interval": {},
  "externalCode": "text",
  "createdAt": "text",
  "externalId": "text",
  "lastModifiedAt": "text",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000",
  "tagIDs": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

Successful request