Customer links

List the customer links of a shipment

Use this to see which customers already have a tracking link for a shipment, and which links were switched off. Active and revoked links are listed, newest first, with keyset paging. Needs the read scope.

get/shipments/{shipment_id}/share_links

Request

  • Base URL: https://trackberry.com/api/v1
  • URL: https://trackberry.com/api/v1/shipments/{shipment_id}/share_links
  • Auth: HTTP bearer

Path parameters

shipment_idstring required

The shipment id (shp_ prefix). An id from another organization, or with another prefix, is a 404.

Query parameters

limitinteger

Maximum number of items in the page, 1 to 100. Decimal digits only; anything else (0, 101, 1e1, 0x10, a negative number) is a 400.

starting_afterstring

The id of the last link of the previous page.

Headers

Trackberry-Versionstring

The API version to build this response for, for example 2026-10-01. Optional: without it the organization's pinned version is used (and the organization is pinned to the latest version on its first request without the header). Applies to this request only. An unpublished version is a 400 with code invalid_version.

Response

A page of customer links.

object'list' required

Always list.

has_moreboolean required

True when more items exist after this page. Pass the last item's id as starting_after to fetch them. Always false for unpaged lists.

Changes

No recorded changes to this operation across all 1 revision of this API.