Sign in
latestOpenAPI 3.1.02026-08-13233474.8 KB

e920ac8ed225

Groups

Get Groups

Get a list of groups scoped by the query parameters.

get/groups

Query parameters

idstring

Group ID.

Group ID.

organizationIdstring

Owning organization ID.

Owning organization ID.

activeboolean

Whether or not the group is active.

Whether or not the group is active.

cursorstring

Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.

Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.

limitnumber

Limit of items per page.

Limit of items per page.

Response

Returns a list of groups that match the query parameters.

cursorstring nullable required

Cursor for start of next set of items. If there were no items to return with the last cursor you passed, this will return null.

hasMoreboolean required

Whether there are more items to load past this cursor.

Example response

{
  "items": [
    {
      "countryCode": "US",
      "location": {
        "label": "Denver, CO, USA",
        "coordinates": {
          "lat": 39.7392358,
          "lng": -104.990251
        }
      },
      "timezone": "America/Denver"
    }
  ]
}