Skip to main content
GET
Get Tms Share Agreement

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

tms_share_agreement_id
string<uuid>
required

Response

Successful Response

API model for reading a sharing agreement

Contains all the details about what TMS-sourced data you can access from a TMS account.

id
string<uuid>
required

Unique agreement identifier

partner_id
string<uuid>
required

Your organization ID receiving access to TMS account data

tms_account_id
string<uuid>
required

The Catena TMS account ID sharing their data with you

tms_invitation_id
string<uuid> | null
required

The TMS invitation that was accepted to create this agreement, if any

status
enum<string>
required

Current state: ACTIVE (data access enabled) or DELETED (permanently removed)

Available options:
active,
deleted
scopes
Shared Scopes · object
required

Defines which TMS-sourced resources (loads, shipments, carriers, etc.) you can access and the permission level (read, write) for each.