AG5.com

List all groupings viewable for API user

get

/groupings

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "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"
}

Successful request

get

/groupings/{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 -L \
  --url '/groupings/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "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": {}
}

Successful request

get

/groupings/{id}/definedGroupings

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}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "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"
}

Successful request

Groupings

DefinedGroupings

Groupings

List all groupings viewable for API user

DefinedGroupings