Skip to navigation

Export Documents Job Status

View as Markdown

Overview

Use this endpoint to retrieve the status and details of a specific export job previously created via the Export Documents endpoint. The job is identified by its numeric id in the path.

This is typically called after submitting an asynchronous export request to check whether the job has completed and to obtain the download URL(s) for the exported document bundle.

Path Parameters

FieldTypeRequiredDescription
idIntYesThe unique identifier of the export job returned by the Export Documents endpoint. For example, /v2/documents/export/1 retrieves the status of export job 1.

Request Headers

AttributeTypeOptionDescription
x-api-keyStringRequiredAPI key used to authenticate the client. Example: {{x-api-key}} or {{apiKey}}.
AuthorizationStringRequiredBearer token for the authenticated user or service. Example: Bearer {{token}}.

Response Body

Returns the current status and details of the export job, including any available download URLs and processing statistics.

Authentication

x-api-keystring
API key issued by Staple.
AuthorizationBearer
JWT obtained from the login endpoint.

Response

OK