Skip to main content
GET
/
v2
/
orgs
/
share-agreements
List Share Agreements
curl --request GET \
  --url https://api.catenatelematics.com/v2/orgs/share-agreements \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "effective_date": "2025-12-11T14:22:00Z",
      "fleet_id": "98765432-10fe-dcba-9876-543210fedcba",
      "fleet_ref": "FLEET-12345",
      "id": "22334455-6677-8899-aabb-ccddeeff0011",
      "invitation_id": "01234567-89ab-cdef-0123-456789abcdef",
      "partner_id": "11223344-5566-7788-99aa-bbccddeeff00",
      "scopes": {
        "hos_events": "read",
        "user": "read",
        "vehicle": "read_write",
        "vehicle_location": "read_write"
      },
      "status": "active"
    }
  ],
  "total": 1,
  "current_page": "<string>",
  "current_page_backwards": "<string>",
  "previous_page": "<string>",
  "next_page": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fleet_id
string<uuid> | null

Limit results to specific fleet

​
fleet_ref
string | null

Limit results to specific fleet reference

​
share_agreement_status
enum<string> | null

Limit results to specific Share Agreement status Enum for share agreement status

Available options:
active,
paused,
cancelled,
deleted,
expired
​
cursor
string | null

Cursor for the next page

​
size
integer
default:300

Page size

Required range: 1 <= x <= 1000

Response

Successful Response

​
items
ShareAgreementRead · object[]
required
​
total
integer
required
Required range: x >= 0
​
current_page
string | null

Cursor to refetch the current page

​
current_page_backwards
string | null

Cursor to refetch the current page starting from the last item

​
previous_page
string | null

Cursor for the previous page

​
next_page
string | null

Cursor for the next page