Substy Developers
Inbox and fans

Get message export status

Check a message export you requested using its jobId. Returns job status, rowCount, truncated and downloadReady. Wait until downloadReady before requesting a download; queued and active jobs have no completed CSV.

GET/v1/agencies/{agencyId}/message-exports/{jobId}

Check a message export you requested using its jobId. Returns job status, rowCount, truncated and downloadReady. Wait until downloadReady before requesting a download; queued and active jobs have no completed CSV.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
jobId*string
Length1 <= length <= 200

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/message-exports/string" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "jobId": "string",    "status": "unknown",    "rowCount": null,    "truncated": null,    "downloadReady": true  },  "meta": {    "requestId": "string"  }}