Terminal Groups API

The Groups API from Terminal — 1 operation(s) for groups.

GitHub OpenAPI

Operations 1

GET /groups List Groups #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/terminal-telematics:terminal-telematics-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

terminal-telematics-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Terminal Telematics Groups API
  description: Terminal is a unified API that makes it easy to integrate with the leading telematics service providers.
  version: '0.0'
  contact:
    name: Terminal
    email: connect@withterminal.com
    url: https://www.withterminal.com
servers:
- url: https://api.withterminal.com/tsp/v1
  description: Production
- url: https://api.sandbox.withterminal.com/tsp/v1
  description: Sandbox
security:
- Authorization: []
tags:
- name: Groups
paths:
  /groups:
    x-mcp:
      enabled: true
    get:
      x-mcp: all
      summary: List Groups
      tags:
      - Groups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
                  next:
                    $ref: '#/components/schemas/PaginationCursor'
                required:
                - results
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '410':
          $ref: '#/components/responses/GoneError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeoutError'
      operationId: listGroups
      x-operation-category: core-data
      x-required-permissions:
      - group:read
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Cursor'
      - schema:
          type: string
          enum:
          - parent
        in: query
        name: expand
        description: Expand resources in the returned response
      - $ref: '#/components/parameters/ConnectionToken'
      - $ref: '#/components/parameters/Raw'
      - $ref: '#/components/parameters/ModifiedAfter'
      - $ref: '#/components/parameters/ModifiedBefore'
      - $ref: '#/components/parameters/Deleted'
components:
  schemas:
    ModifiedAt:
      title: ModifiedAt
      type: string
      format: date-time
      description: '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.'
    ExpandedGroup:
      title: Expanded Group
      type: object
      properties:
        id:
          $ref: '#/components/schemas/GroupId'
        sourceId:
          type: string
          example: '12345'
        provider:
          $ref: '#/components/schemas/ProviderCode'
        name:
          type: string
          example: California Division
        description:
          type: string
          example: Resources part of the California division
        parent:
          $ref: '#/components/schemas/GroupId'
          description: The parent of this group.
        createdAt:
          $ref: '#/components/schemas/SourceCreatedAt'
        updatedAt:
          $ref: '#/components/schemas/SourceUpdatedAt'
        metadata:
          $ref: '#/components/schemas/CoreEntityMetadata'
        raw:
          $ref: '#/components/schemas/RawDataList'
      required:
      - id
      - sourceId
      - provider
      - metadata
      x-description: A group represents a collection of assets (vehicles, trailers, drivers) defined by the provider.
    DeletedAt:
      title: DeletedAt
      type: string
      format: date-time
      description: '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.'
    RawDataList:
      title: RawDataList
      type: array
      example: []
      items:
        $ref: '#/components/schemas/RawData'
    SourceCreatedAt:
      title: SourceCreatedAt
      type: string
      format: date-time
      description: '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.'
    PaginationCursor:
      title: Pagination Cursor
      type: string
      example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
      description: Cursor used for pagination.
      format: cursor
      pattern: ^[A-Za-z0-9+/=_-]+$
    AddedAt:
      title: AddedAt
      type: string
      format: date-time
      description: '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.'
    ErrorPathDetail:
      title: ErrorPathDetail
      type: object
      properties:
        message:
          type: string
          example: '''vehicleId'' property must be a valid ulid'
        path:
          type: string
          example: '{requestQuery}.vehicleId'
        suggestion:
          type: string
          example: Please ensure you submit a valid 'vehicleId' property
        context:
          type: object
      required:
      - message
      - path
    RawData:
      title: RawData
      type: object
      properties:
        provider:
          type: string
        schema:
          type: string
        extractedAt:
          type: string
        data:
          type: object
      required:
      - provider
      - schema
      - extractedAt
      - data
    GroupId:
      title: GroupId
      type: string
      format: ulid
      example: group_01D8ZQFGHVJ858NBF2Q7DV9MNC
    SourceUpdatedAt:
      title: SourceUpdatedAt
      type: string
      format: date-time
      description: '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.'
    ExpandableGroup:
      example: group_01D8ZQFGHVJ858NBF2Q7DV9MNC
      oneOf:
      - $ref: '#/components/schemas/GroupId'
      - $ref: '#/components/schemas/ExpandedGroup'
    ProviderCode:
      type: string
      example: geotab
      description: Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under [provider details](/providers).
    Group:
      title: Group
      type: object
      x-model-category: entity
      x-read-permission: group:read
      properties:
        id:
          $ref: '#/components/schemas/GroupId'
        sourceId:
          type: string
          example: '12345'
        provider:
          $ref: '#/components/schemas/ProviderCode'
        name:
          type: string
          example: California Division
        description:
          type: string
          example: Resources part of the California division
        parent:
          $ref: '#/components/schemas/ExpandableGroup'
          description: The parent of this group.
        createdAt:
          $ref: '#/components/schemas/SourceCreatedAt'
        updatedAt:
          $ref: '#/components/schemas/SourceUpdatedAt'
        metadata:
          $ref: '#/components/schemas/CoreEntityMetadata'
        raw:
          $ref: '#/components/schemas/RawDataList'
      required:
      - id
      - sourceId
      - provider
      - metadata
      x-description: A group represents a collection of assets (vehicles, trailers, drivers) defined by the provider.
    CoreEntityMetadata:
      title: CoreEntityMetadata
      type: object
      description: Internal metadata about the record.
      required:
      - addedAt
      - modifiedAt
      properties:
        addedAt:
          $ref: '#/components/schemas/AddedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        deletedAt:
          $ref: '#/components/schemas/DeletedAt'
        visibility:
          type: string
          enum:
          - visible
          - hidden_by_exclude_list
          - hidden_by_include_list
          - hidden_by_status
          - deleted
          example: visible
          description: Visibility status of a resource. Read more about hidden records [here](https://docs.withterminal.com/guides/vehicle-driver-filtering).
  parameters:
    Raw:
      name: raw
      in: query
      required: false
      schema:
        type: boolean
      description: Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.
    ConnectionToken:
      name: Connection-Token
      in: header
      required: true
      schema:
        type: string
        example: con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4
        pattern: ^con_tkn_\S+$
      description: The token returned when a user authenticated their account. This authorizes access to a specific account.
    Limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
      description: The maximum number of results to return in a page.
    ModifiedBefore:
      name: modifiedBefore
      in: query
      required: false
      schema:
        type: string
        format: date-time
        example: '2021-01-06T03:24:53.000Z'
      description: Only include records that were last modified before a provided date.
    Cursor:
      name: cursor
      in: query
      schema:
        type: string
        format: cursor
        pattern: ^[A-Za-z0-9+/=_-]+$
        example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
      description: Pagination cursor to start requests from
    ModifiedAfter:
      name: modifiedAfter
      in: query
      required: false
      schema:
        type: string
        format: date-time
        example: '2021-01-06T03:24:53.000Z'
      description: Only include records that were last modified after a provided date.
    Deleted:
      name: deleted
      in: query
      required: false
      schema:
        type: boolean
      description: Show "soft-deleted" records that have been deleted from the provider. Defaults to false.
  responses:
    GoneError:
      description: Gone
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                enum:
                - gone
                - connection_deleted
                example: connection_deleted
              message:
                type: string
                example: Connection has been deleted and cannot be used
            required:
            - code
            - message
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                enum:
                - forbidden
              message:
                type: string
                example: Forbidden Request
              detail:
                type: string
                example: Please ensure the connection token matches the resource you are attempting to access.
            required:
            - code
            - message
    BadRequestError:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                enum:
                - bad_request
              message:
                type: string
                example: Invalid request body
              detail:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorPathDetail'
            required:
            - code
            - message
    GatewayTimeoutError:
      description: Gateway Timeout Error
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                enum:
                - gateway_timeout
                - provider_timeout
                description: '`provider_timeout` means the telematics provider did not respond in time, or responded too slowly to finish the request (for example, while paginating). Retry later or narrow the request, for example with a shorter time range or smaller `limit`. `gateway_timeout` means Terminal could not finish the request in time for another reason.'
              message:
                type: string
                example: Gateway Timeout
            required:
            - code
            - message
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                enum:
                - unauthorized
              message:
                type: string
                example: Unauthorized Request
              detail:
                type: string
                example: Please ensure you have a valid API key
            required:
            - code
            - message
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                enum:
                - internal_server_error
              message:
                type: string
                example: Internal Server Error
              detail:
                type: string
                example: Something went wrong
            required:
            - code
            - message
    TooManyRequestsError:
      description: Too Many Requests
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
            properties:
              code:
                enum:
                - too_many_requests
              retryAfter:
                description: The number of seconds to wait before retrying the request
                type: integer
                example: 60
              message:
                type: string
                example: Too Many Requests
              detail:
                type: string
                example: You have exceeded your rate limit. Please try again later.
            required:
            - code
            - message
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer