> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.staple.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.staple.ai/_mcp/server. # Export Documents Job Status GET https://api.staple.io/v2/documents/export/1 ## 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 | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | Int | Yes | The 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 | Attribute | Type | Option | Description | | --- | --- | --- | --- | | x-api-key | String | Required | API key used to authenticate the client. Example: `{{x-api-key}}` or `{{apiKey}}`. | | Authorization | String | Required | Bearer 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. Reference: https://docs.staple.ai/api-reference/v2/documents/export-documents-job-status ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: v2 version: 1.0.0 paths: /v2/documents/export/1: get: operationId: exportDocumentsJobStatus summary: Export Documents Job Status description: >- ## 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 | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | Int | Yes | The 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 | Attribute | Type | Option | Description | | --- | --- | --- | --- | | x-api-key | String | Required | API key used to authenticate the client. Example: `{{x-api-key}}` or `{{apiKey}}`. | | Authorization | String | Required | Bearer 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. tags: - documents parameters: - name: x-api-key in: header description: API key issued by Staple. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Documents_exportDocumentsJobStatus_Response_200 servers: - url: https://api.staple.io description: https://api.staple.io components: schemas: Documents_exportDocumentsJobStatus_Response_200: type: object properties: {} description: Empty response body title: Documents_exportDocumentsJobStatus_Response_200 securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: API key issued by Staple. bearerAuth: type: http scheme: bearer description: JWT obtained from the login endpoint. ``` ## Examples **Request** ```json {} ``` **Response** ```json { "getExportJob": { "downloadUrls": [ "https://d32x7illouhewd.cloudfront.net/exports/5241/1/1_part1.csv?Expires=1766299007&Key-Pair-Id=KT9PAIC8JNMBA&Signature=iwjFrSDyzUtNeoK4dbdVIN1H9Uql~Bgr-YUTAyroxq25mN1k58NusWwUtp9ejF8LVpsEjHZj3tzmDOZv2NIYEhjWjhT3q3~wO9nOfMNrUu~pDboyCZKcW3-yE9owdbUwe7YZKuOrbIIbOyxCQ24TDmQc~a4VE0SSfcVHA6ZYNyst2L2pOJLHfSEgp7HS890-tuYxQWCynaaigLpoLF5I85Dp0m99OMgRIrU~K6p5e2cZ06ky8f1AYU8t08cDAeCMN8JPcrYD2OK6vpI4ztcXyHFCLVKsSn3a86Y2tZzL6H65CVupWAxSqXRYX3DaXrdmL8Gj6aeMk9xFIbFID-Sugw__" ], "emails": [ "aman@staple.io" ], "errorMessage": null, "filters": { "qids": [ 13315 ], "state": [ "COMPLETED" ] }, "format": "CSV", "id": 1, "processedDocuments": 2, "status": "COMPLETED", "totalDocuments": 2, "uid": 5241 } } ``` **SDK Code** ```python import requests url = "https://api.staple.io/v2/documents/export/1" payload = {} headers = { "x-api-key": "", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.staple.io/v2/documents/export/1'; const options = { method: 'GET', headers: {'x-api-key': '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.staple.io/v2/documents/export/1" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("x-api-key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.staple.io/v2/documents/export/1") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.staple.io/v2/documents/export/1") .header("x-api-key", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.staple.io/v2/documents/export/1', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.staple.io/v2/documents/export/1"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "x-api-key": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.staple.io/v2/documents/export/1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```