Skip to main content
POST
List groupings

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[]

List of grouping types to include.

names
string[]

List of grouping names to include.

Response

OK

groupings
object[]