List Tms Invitations

GET

https://api.catenatelematics.com/v2/orgs/tms-invitations

GET

/v2/orgs/tms-invitations

curl https://api.catenatelematics.com/v2/orgs/tms-invitations \
     -H "Authorization: Bearer <token>"

{
  "items": [
    {
      "id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "magic_link": "string",
      "expires_at": "2024-01-15T09:30:00Z",
      "expires_in_hours": 1,
      "status": "active",
      "tms_account_ref": "string",
      "partner_id": "string",
      "partner_slug": "string",
      "accepted_at": "2024-01-15T09:30:00Z",
      "accepted_by": "string",
      "pre_registration_access_token": "string",
      "pre_registration_refresh_token": "string",
      "decline_reason": "string",
      "declined_at": "2024-01-15T09:30:00Z",
      "limit_tms": [
        "string"
      ],
      "exclude_tms": [
        "string"
      ],
      "permissions": {},
      "tms_account_id": "string"
    }
  ],
  "total": 1,
  "current_page": "string",
  "current_page_backwards": "string",
  "previous_page": "string",
  "next_page": "string"
}

Get a paginated list of all TMS invitations accessible to your organization.

Authentication

AuthorizationBearer

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

Query parameters

tms_account_refstring or nullOptional

Limit results to a specific TMS account reference

cursorstring or nullOptional

Cursor for the next page

sizeintegerOptional1-1000Defaults to 300

Page size

Response

Successful Response

itemslist of objects

totalinteger>=0

current_pagestring or nullOptional

Cursor to refetch the current page

current_page_backwardsstring or nullOptional

Cursor to refetch the current page starting from the last item

previous_pagestring or nullOptional

Cursor for the previous page

next_pagestring or nullOptional

Cursor for the next page

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error