---
title: "Get a background export"
method: GET
path: "/api/v1/exports/{job_id}"
tags: ["Export"]
---

# Get a background export

`GET /api/v1/exports/{job_id}`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/exports/{job_id}`
- Auth: HTTP bearer

`status` goes `pending`, `running`, then `ready` or `failed` (`error` says why). Poll `GET /exports/{id}` until `status` is `ready`, then call `GET /exports/{id}/download`: it redirects (307) to a signed URL valid 10 minutes. API clients must follow the redirect. Requires the `export.bulk` scope, which the Team and Enterprise plans open (401 anonymous, 403 `SCOPE_MISSING` on any other plan).

## Path parameters

- `job_id` string, required

## Response `200`

Successful Response

- ApiResponseExportJobResponse
  - `success` boolean, required
  - `data` ExportJobResponse: A background export as the API serves it. Only what the row carries.
    - `id` string, required
    - `status` 'pending' | 'running' | 'ready' | 'failed', required
    - `filename` string, required
    - `description` string, nullable
    - `size_bytes` integer
    - `error` string, nullable: Why the job failed, when it did
    - `created_at` string, nullable
    - `expires_at` string, nullable: The archive is deleted after this instant (7 days)
    - `download_url` string, nullable: Set once status is `ready`: redirects to a signed URL valid 10 minutes
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

## Other responses

- `404`: No such export in this workspace
- `422`: Validation Error

---

[API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)