Skip to main content
POST
Fetch client data

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

query
string
required

Query to fetch.

limit
number

Maximum number of records to fetch.

offset
number

Number of records to skip.

Response

Fetch client data

count
number
required

Total number of records.

records
Records · object[]
required

Fetched records.