Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Groups

List Groups

get/groups

Query parameters

limitinteger

The maximum number of results to return in a page.

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

expand'parent'

Expand resources in the returned response

rawboolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

modifiedAfterstring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified after a provided date.

modifiedBeforestring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified before a provided date.

deletedboolean

Show "soft-deleted" records that have been deleted from the provider. Defaults to false.

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

The token returned when a user authenticated their account. This authorizes access to a specific account.

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "id": "group_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "12345",
      "provider": "geotab",
      "name": "California Division",
      "description": "Resources part of the California division",
      "parent": "group_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "metadata": {
        "visibility": "visible"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}