---
title: "List Groups"
method: GET
path: "/groups"
tags: ["Groups"]
---

# List Groups

`GET /groups`

## Query parameters

- `limit` integer
- `cursor` string, cursor
- `expand` 'parent'
- `raw` boolean
- `modifiedAfter` string, date-time
- `modifiedBefore` string, date-time
- `deleted` boolean

## Headers

- `X-Application-Id` string
- `Connection-Token` string, required

## Response `200`

OK

- object
  - `results` object[], required
    - `id` string, ulid, required
    - `sourceId` string, required
    - `provider` string, required — Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under [provider details](/providers).
    - `name` string
    - `description` string
    - `parent` union — Optional parent group. This is expandable.
      - string, ulid
      - object
        - `id` string, ulid, required
    - `createdAt` string, date-time — The date and time the record was created in the provider's system. This timestamp comes directly from the source system and represents when the data was originally created there. Note: not all providers expose this.
    - `updatedAt` string, date-time — The date and time the record was updated in the provider's system. This timestamp comes directly from the source system and represents when the data was last updated there. Note: not all providers expose this.
    - `metadata` object, required — Internal metadata about the record.
      - `addedAt` string, date-time, required — The date and time the record was ingested into Terminal. Note: this is not the date and time the record was created in the provider's system.
      - `modifiedAt` string, date-time, required — The date and time the record was last updated in Terminal. Note: this is not the date and time the record was updated in the provider's system.
      - `deletedAt` string, date-time — The date and time the record was deleted from Terminal. Note: this is not the date and time the record was deleted in the provider's system.
      - `visibility` 'visible' | 'hidden_by_exclude_list' | 'hidden_by_include_list' | 'hidden_by_status' | 'deleted' — Visibility status of a resource. Read more about hidden records [here](https://docs.withterminal.com/guides/filtering).
    - `raw` object[]
      - `provider` string, required
      - `schema` string, required
      - `extractedAt` string, required
      - `data` object, required
  - `next` string, cursor — Cursor used for pagination.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests
- `500` — Internal Server Error
- `504` — Gateway Timeout Error

---

[API](https://skmtc.dev/withterminal/apis/terminal-telematics-api.md) · [All operations](https://skmtc.dev/withterminal/apis/terminal-telematics-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withterminal/terminal-telematics-api/revisions/90249c4a1739/schema)