Skip to main content
POST
Request export

Authorizations

Authorization
string
header
required

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

Body

application/json
endpoint
enum<string>
required

API endpoint to export data from

Available options:
/api/v2/call,
/api/v2/campaign,
/api/v2/phone-numbers,
/api/v2/feedbacks
params
object
required

Query parameters to pass to the endpoint (must include workspaceId)

format
enum<string>
default:csv

Export file format

Available options:
csv,
xlsx,
markdown,
json
deliveryMethod
enum<string>
default:download

How to deliver the export

Available options:
download,
email
email
string<email> | null

Email address for email delivery

Response

Export ready or email sent

success
enum<boolean>
required
Available options:
true
data
object
required