Skip to main content
GET
/
data_exports
/
{document_export_id}
Get the export job status by ID
curl --request GET \
  --url https://api.sandbox.monite.com/v1/data_exports/{document_export_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "count": 123,
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "format": "<string>",
  "language": "<string>",
  "status": "<string>",
  "created_by_entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "end_datetime": "2023-11-07T05:31:56Z",
  "source_url": "<string>",
  "start_datetime": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

document_export_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
count
integer
required
entity_id
string<uuid>
required
format
string
required
language
string
required
status
string
required
created_by_entity_user_id
string<uuid>
end_datetime
string<date-time>
source_url
string<uri>
Required string length: 1 - 2083
start_datetime
string<date-time>