GET
/
groups
List Groups
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "id": "group_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "12345",
      "provider": "geotab",
      "name": "California Division",
      "description": "Resources part of the California division",
      "parent": "group_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {
        "addedAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "visibility": "visible"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Connection-Token
string
required

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

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

​
limit
integer

The maximum number of results to return in a page.

​
cursor
string<cursor>

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
expand
enum<string>

Expand resources in the returned response

Available options:
parent
​
raw
boolean

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

​
modifiedAfter
string<date-time>

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

Example:

"2021-01-06T03:24:53.000Z"

​
modifiedBefore
string<date-time>

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

Example:

"2021-01-06T03:24:53.000Z"

​
deleted
boolean

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

Response

200
application/json

OK

The response is of type object.