JUjumpcloud
Agent Groups

List agent groups

Retrieves a paginated list of agent groups in your organization.

get/api/v2/agentgroups

Request

Query parameters

fieldsstring[]

The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.

filterstring[]

A filter to apply to the query.

Filter structure: <field>:<operator>:<value>.

field = Populate with a valid field from an endpoint response.

operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.

value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.

EX: GET /api/v2/groups?filter=name:eq:Test+Group

limitinteger

The number of records to return at once. Limited to 100.

skipinteger

The offset into the records to return.

sortstring[]

The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

OK

attributesGraphAttributes nullable

The graph attributes.

descriptionstring

Description of the agent group.

idstring

Agent group ID (24-character hexadecimal string).

namestring

Display name of the agent group. Can be used in the filter query parameter when listing agent groups.

organizationObjectIdstring nullable

ID of the organization that owns the agent group (24-character hexadecimal string).

type'agent_group'

The type of the group; always agent_group for an agent group.

Changes

No recorded changes to this operation across all 1 revision of this API.