attributeGroups.list

List accessible attribute groups, their management types, and their attribute values.

Groups are ordered by position, then ID. Values within each group are ordered by position, then name. Empty groups are included with attributes: [].

Hidden groups are included. Privileged groups are included only when the request uses a personal access token whose user can view privileged attributes; other tokens receive only non-privileged groups.

Facts


Method	`GET https://api.getdx.com/attributeGroups.list`
Required scope	`snapshots:read`

Arguments

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.

Example request

This request lists the attribute groups accessible to the token:

curl -X GET 'https://api.getdx.com/attributeGroups.list' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

Example response

This is a typical success response:

{
  "ok": true,
  "attribute_groups": [
    {
      "id": "MTAx",
      "name": "Location",
      "type": "admin_managed",
      "hidden": false,
      "position": 1,
      "privileged": false,
      "attributes": [
        {
          "id": "NDAx",
          "name": "US-East",
          "position": 1
        },
        {
          "id": "NDAy",
          "name": "Northeast",
          "position": 2
        }
      ]
    }
  ]
}

Response fields

Attribute group list item

Each list item contains the AttributeGroup fields plus an attributes array.

Field	Type	Description
`id`	`String`	The unique attribute-group ID.
`name`	`String`	The attribute-group name.
`type`	`String`	`admin_managed`, `self_reported`, `dx_managed`, or `sql_powered`.
`hidden`	`Boolean`	Whether the group is configured as hidden. Hidden groups are still returned by this endpoint.
`position`	`Integer` or `null`	The configured group ordering position.
`privileged`	`Boolean`	Whether viewing the group requires privileged-attribute access.
`attributes`	`Array`	Attribute values that belong to this group.

Attribute object

Field	Type	Description
`id`	`String`	The unique attribute value ID.
`name`	`String`	The attribute value name.
`position`	`Integer` or `null`	The configured attribute ordering position.

Errors

Check ok in every response. If it is false, use the error code to identify the problem.

Error	Description
`not_authed`	The authentication token is missing or invalid.
`not_authorized`	The token lacks access, including the required `snapshots:read` scope.