Skip to main content
POST
/
ims
/
groupings
/
list
List groupings
curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/groupings/list \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrierId": 123,
  "includedGroupingTypes": [
    "<string>"
  ]
}
'
{
  "groupings": [
    {
      "resourceType": "Grouping",
      "resourceId": 123,
      "groupingType": "<string>",
      "attributes": {},
      "rules": {},
      "equipmentIndexEnabled": false,
      "objectType": "EQUIPMENT",
      "uuid": "<string>",
      "name": "<string>",
      "colorToken": "<string>",
      "deletedAt": "<string>",
      "updatedAt": "<string>",
      "carrierId": 123
    }
  ]
}

Authorizations

​
x-arms-api-key
string
header
required

Your ARMS API key

​
x-arms-assume-user
string
header
required

Email of a user assigned to the appropriate user group

Query Parameters

​
carrierId
integer
required

Carrier identifier; required for all endpoints

​
viewAsUserGroup
string

Optional user group context

Body

application/json
​
carrierId
integer
required

Carrier identifier used to scope groupings.

​
includedGroupingTypes
string[]

Response

OK

​
groupings
object[]