Terminal Link API

The Link API from Terminal — 2 operation(s) for link.

GitHub OpenAPI

Operations 2

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-link-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-link-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Terminal Telematics Link 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: Link
paths:
  /link/short:
    x-mcp:
      enabled: true
    post:
      summary: Create Short Link URL
      operationId: createShortLink
      x-operation-category: control-plane
      description: 'Create a short URL for the Link onboarding flow as an alternative to the full Link URL with all its query parameters.


        The response contains a durable `id`, an 8-character `code`, and the full `url` to share with your user. Short links are valid for 1 year from creation.


        Store the `id` if you may need to delete the short link later. The public `code` / `url` alone cannot be used to revoke a link.


        Identical request bodies are de-duplicated automatically. Calling this endpoint a second time with the same parameters returns the original short link (including its `id`) with an `Idempotent-Replayed: true` response header.'
      tags:
      - Link
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  $ref: '#/components/schemas/ProviderCode'
                providerHints:
                  type: array
                  description: An optional list of provider codes to hoist to the top of the Link provider list.
                  items:
                    $ref: '#/components/schemas/ProviderCode'
                externalId:
                  type: string
                  example: fleet_456
                  description: An optional ID from your system that can be used to reference connections.
                name:
                  type: string
                  description: An optional human-readable name to associate with the resulting connection.
                tags:
                  type: array
                  description: An optional list of tags from your system that can be used to reference connections.
                  items:
                    type: string
                    example: Tag Name
                redirectUrl:
                  type: string
                  format: uri
                  example: https://app.acme.com/telematics-success
                  description: URL to redirect your user to after they complete the Link flow.
                syncMode:
                  $ref: '#/components/schemas/SyncMode'
                backfill:
                  additionalProperties: false
                  description: Optional backfill to be requested upon successful connection. Will start from NOW if not provided.
                  type: object
                  properties:
                    startFrom:
                      $ref: '#/components/schemas/ISODateTime'
                    days:
                      type: number
                template:
                  title: LinkTemplateId
                  description: Unique identifier for the Link Template.
                  type: string
                  format: ulid
                  example: ltp_01HXQ4YK8V2X0X0X0X0X0X0X0X
      responses:
        '200':
          description: OK
          headers:
            Idempotent-Replayed:
              schema:
                type: boolean
                enum:
                - true
              description: Always `true` on a 200 response. It indicates that an existing short link was returned instead of minting a new one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShortLink'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShortLink'
        '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'
  /link/short/{id}:
    parameters:
    - schema:
        $ref: '#/components/schemas/ShortLinkId'
      name: id
      in: path
      required: true
    x-mcp:
      enabled: true
    delete:
      summary: Delete Short Link
      operationId: deleteShortLink
      x-operation-category: control-plane
      description: 'Permanently delete a short link by its durable `id` from the create response (`slk_…`). This endpoint does not accept the 8-character `code` from the shared URL.


        After deletion, the short URL stops resolving immediately and the code may be reused by a future mint.'
      tags:
      - Link
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeoutError'
components:
  responses:
    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
    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
    NotFoundError:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                enum:
                - not_found
              message:
                type: string
                example: Resource not found
              detail:
                type: string
                example: 'Could not find resource with ID: 2342342'
            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
    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
  schemas:
    SyncMode:
      title: SyncMode
      type: string
      enum:
      - automatic
      - manual
      description: 'Enum values:

        - `automatic`: Terminal will keep this connections data up to date

        - `manual`: Terminal will only sync data upon request'
      default: automatic
    ShortLinkId:
      title: ShortLinkId
      description: Unique identifier for a short link. Returned on create and required to delete the short link.
      type: string
      format: ulid
      pattern: ^slk_[0-9A-HJKMNP-TV-Z]{26}$
      example: slk_01JB7K3N2QZP7TVR4FX8SDWFH9
    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
    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).
    ShortLink:
      title: ShortLink
      type: object
      description: A short URL for the Link onboarding flow. The associated parameters are stored at creation time and retrieved when your user visits the URL.
      properties:
        id:
          $ref: '#/components/schemas/ShortLinkId'
          description: Durable identifier for the short link resource. Store this value if you may need to delete the short link later; it is the only identifier accepted by the delete endpoint.
        code:
          type: string
          pattern: ^[a-hjkmnp-z2-9]{8}$
          example: az9qtk2d
          description: 8-character code that is associated with the original Link parameters. Used in the shared URL; cannot be used to delete the short link.
        url:
          type: string
          format: uri
          example: https://term.new/az9qtk2d
          description: Full short URL to share with your user.
        expiresAt:
          $ref: '#/components/schemas/ISODateTime'
          description: Timestamp at which the short link will stop resolving. It is set to 1 year from creation date.
      required:
      - id
      - code
      - url
      - expiresAt
    ISODateTime:
      title: ISODateTime
      type: string
      format: date-time
      example: '2021-01-06T03:24:53.000Z'
      description: '[ISO 8601](https://www.w3.org/TR/NOTE-datetime) date'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer