Skip to main content
GET
/
shipment
List shipments
curl --request GET \
  --url https://api.truecold.io/shipment \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "code": "<string>",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "soft_deleted": "2023-11-07T05:31:56Z",
    "soft_deleted_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "emails_to_notify": [
      "<string>"
    ],
    "risk_score": 123
  }
]

Documentation Index

Fetch the complete documentation index at: https://integrations.truecold.io/llms.txt

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

Authorizations

​
x-api-key
string
header
required

API key for authentication. Contact your administrator to get an API key.

Query Parameters

​
search
string

Search term to filter results

​
page
integer

Page number for pagination

Required range: x >= 1
​
pageSize
integer

Number of items per page

Required range: 1 <= x <= 100

Response

Successfully retrieved shipments

​
id
string<uuid>

Unique identifier

​
code
string

code code

​
account_id
string<uuid>

Account ID

​
site_id
string<uuid>

Site ID

​
created_at
string<date-time>

Creation timestamp

​
soft_deleted
string<date-time>

Soft deletion timestamp

​
soft_deleted_by
string

User who soft deleted the record

​
updated_at
string<date-time>

Last update timestamp

​
emails_to_notify
string[]

Email address

​
risk_score
number | null

Risk score