Groupings

List all groupings viewable for API user

get

Authorizations

bearer-token

AuthorizationstringRequired

This API uses Bearer token authentication.

Requests to this API should contain an Authorization header like this:

Authorization: Bearer [Token]

Query parameters

pageTokenstringOptional

limitinteger · int32Optional

sinceDeltaTokenstringOptional

fieldsstring[]Optional

Responses

200

Successful request

application/json

deltaTokenstringRequired

pageTokenstringRequired

get

/groupings

HTTPcURLJavaScriptPython

GET /groupings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful request

{
  "results": [
    {
      "code": "text",
      "lastModifiedAt": "text",
      "typeID": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "createdAt": "text",
      "description": "text",
      "externalId": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "text",
      "definedInGroupingID": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {}
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

get

Authorizations

bearer-token

AuthorizationstringRequired

This API uses Bearer token authentication.

Requests to this API should contain an Authorization header like this:

Authorization: Bearer [Token]

Path parameters

idstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[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

200

Successful request

application/json

codestringRequired

lastModifiedAtstring · timestampRequired

typeIDstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[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}$

externalCodestringOptional

createdAtstring · timestampRequired

descriptionstringOptional

externalIdstringOptional

idstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[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}$

namestringRequired

definedInGroupingIDstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[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}$

intervalobject · objectRequired

get

/groupings/{id}

HTTPcURLJavaScriptPython

GET /groupings/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful request

{
  "code": "text",
  "lastModifiedAt": "text",
  "typeID": "550e8400-e29b-41d4-a716-446655440000",
  "externalCode": "text",
  "createdAt": "text",
  "description": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "text",
  "definedInGroupingID": "550e8400-e29b-41d4-a716-446655440000",
  "interval": {}
}