Terminal Usage API

The Usage API from Terminal — 1 operation(s) for usage.

GitHub OpenAPI

Operations 1

GET /usage List Usage #

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-usage-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-usage-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Terminal Telematics Usage 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: Usage
paths:
  /usage:
    x-mcp:
      enabled: true
    get:
      x-mcp: all
      summary: List Usage
      operationId: listUsage
      x-operation-category: control-plane
      description: List billable vehicle and backfill usage for an application by ISO month.
      tags:
      - Usage
      x-hidden: true
      parameters:
      - name: month
        in: query
        required: true
        schema:
          type: string
          pattern: ^\d{4}-(0[1-9]|1[0-2])$
          description: ISO month in YYYY-MM format
          example: 2025-08
        description: ISO month to retrieve usage for, in YYYY-MM format.
      - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeoutError'
components:
  responses:
    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
    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
    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
    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
  schemas:
    VehicleId:
      title: VehicleId
      description: Unique identifier for the vehicle in Terminal.
      type: string
      format: ulid
      pattern: ^vcl_[0-9A-HJKMNP-TV-Z]{26}$
      example: vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC
    UsageRow:
      title: Usage Row
      type: object
      description: Billable usage for a connection and vehicle in an ISO month.
      properties:
        connection:
          $ref: '#/components/schemas/ConnectionId'
        vehicle:
          $ref: '#/components/schemas/VehicleId'
        backfillUnitCount:
          type: integer
          minimum: 1
      required:
      - connection
      - vehicle
    UsageResponse:
      title: Usage Response
      type: object
      description: Billable usage for an application in an ISO month.
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/UsageRow'
        next:
          type: string
          format: cursor
          pattern: ^[A-Za-z0-9+/=_-]+$
      required:
      - results
    ConnectionId:
      title: ConnectionId
      type: string
      format: ulid
      example: conn_01GV12VR4DJP70GD1ZBK0SDWFH
    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
  parameters:
    Cursor:
      name: cursor
      in: query
      schema:
        type: string
        format: cursor
        pattern: ^[A-Za-z0-9+/=_-]+$
        example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
      description: Pagination cursor to start requests from
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer