Skip to main content
POST
/
systemOfRecordIntegration
/
clients
/
{uuid}
/
download
Download client data
curl --request POST \
  --url https://api.getcargo.io/v1/systemOfRecordIntegration/clients/{uuid}/download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "format": "csv"
}
'
{
  "urls": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
uuid
string
required

Resource UUID

Body

application/json

Request body schema.

​
command
string
required

Query or command to download.

​
format
enum<string>

Download format.

Available options:
csv,
parquet

Response

Successful response

​
urls
string[]
required

Download URLs.