> ## Documentation Index > Fetch the complete documentation index at: https://docs.closient.com/llms.txt > Use this file to discover all available pages before exploring further. # Poll an organization data export > Return the status of a previously-requested export. Once `status` is `completed`, the response carries a time-limited signed `download_url`. ## OpenAPI ````yaml /openapi/openapi-dashboard.json get /dashboard/api/v1/data-export/{organization_id}/{job_id} openapi: 3.1.0 info: title: Brand Dashboard API (Internal) version: 1.0.0 description: > Internal endpoints powering the brand dashboard UI. Not intended for external integrations — use the Products, Brands, and other public APIs instead. ## Authentication All endpoints require an API key passed via the `X-API-Key` HTTP header, unless otherwise noted. ``` X-API-Key: csb__ ``` Generate API keys in **Settings > API Keys** in your dashboard, or via the Account API. Session-based (cookie) authentication is also accepted for browser-based access. ## Rate Limits | Tier | Requests / minute | Requests / day | |-------------|-------------------|----------------| | Default | 300 | 10,000 | | Custom | Contact us | Contact us | Rate-limit headers are included on every response so callers can self-throttle without hitting our 429s ("informed governor"): - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400` - `RateLimit-Limit` — quota for the **most-restrictive** currently-active window - `RateLimit-Remaining` — requests left in that window - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew safe) Legacy `X-RateLimit-*` aliases are also emitted for back-compat. `X-RateLimit-Reset` keeps the absolute Unix-timestamp shape to avoid breaking existing consumers. When rate-limited, you receive `429 Too Many Requests` with a `retry_after_seconds` field in the error envelope and a `Retry-After` header. ## Pagination List endpoints return paginated results in this envelope: ```json { "data": [...], "pagination": { "page": 1, "page_size": 25, "total_count": 342, "total_pages": 14, "has_next": true, "has_previous": false } } ``` Use `?page=2&page_size=50` query parameters. Maximum page size is 100. ## Error Responses All errors conform to [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) with `Content-Type: application/problem+json`: ```json { "type": "https://closient.com/docs/errors/not_found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "error_code": "not_found", "retryable": false, "timestamp": "2026-03-31T12:00:00+00:00" } ``` Common error codes: `unauthorized` (401), `forbidden` (403), `not_found` (404), `validation_error` (422), `rate_limited` (429), `internal_error` (500). termsOfService: https://www.closient.com/terms/ servers: - url: https://www.closient.com security: [] externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /dashboard/api/v1/data-export/{organization_id}/{job_id}: get: tags: - Data Export summary: Poll an organization data export description: >- Return the status of a previously-requested export. Once `status` is `completed`, the response carries a time-limited signed `download_url`. operationId: apps_dashboard_api_data_export_get_org_export parameters: - in: path name: organization_id schema: description: UUID of the organization. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Organization Id type: string required: true description: UUID of the organization. - in: path name: job_id schema: description: UUID of the export job returned by the create endpoint. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Job Id type: string required: true description: UUID of the export job returned by the create endpoint. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrgExportStatusOut' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: OrgExportStatusOut: description: Status of an export job, with a signed download URL once complete. examples: - archive_format: zip download_url: >- https://example-bucket.s3.amazonaws.com/media/org-exports/.../export.zip?X-Amz-Signature=... expires_at: '2026-06-26T22:00:00+00:00' file_size_bytes: 184320 format_version: '1.0' job_id: a1b2c3d4e5f6g7h8i9j0k1 output_filename: closient-export-acme-foods-20260626-210000.zip sections: - key: organization record_count: 1 status: ok - binary_count: 240 key: products record_count: 120 status: ok status: completed properties: job_id: description: Public identifier of the export job; use it to poll this endpoint. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Job Id type: string status: $ref: '#/components/schemas/OrgExportStatusEnum' description: Current job lifecycle state. archive_format: $ref: '#/components/schemas/OrgExportArchiveFormatEnum' description: Container format of the generated archive. format_version: description: Export format version baked into the archive manifest. title: Format Version type: string output_filename: anyOf: - type: string - type: 'null' description: Suggested filename for the downloaded archive. title: Output Filename file_size_bytes: description: Size of the generated archive in bytes (0 until complete). title: File Size Bytes type: integer download_url: anyOf: - type: string - type: 'null' description: >- Time-limited signed URL to download the archive. Null until the job is complete. title: Download Url expires_at: anyOf: - type: string - type: 'null' description: ISO-8601 instant after which the download URL stops working. title: Expires At sections: description: >- Per-section inventory of what was exported (also present inside the archive manifest). items: $ref: '#/components/schemas/OrgExportSectionOut' title: Sections type: array error: anyOf: - type: string - type: 'null' description: Job-level error message if the export failed. title: Error required: - job_id - status - archive_format - format_version - file_size_bytes title: OrgExportStatusOut type: object ErrorOut: description: |- RFC 9457 Problem Details response. All API errors are returned in this format with Content-Type: application/problem+json. examples: - detail: The requested resource was not found. error_code: not_found retryable: false status: 404 timestamp: '2026-03-31T12:00:00+00:00' title: Not Found type: https://closient.com/docs/errors/not_found - detail: Validation error. details: - loc: - body - name msg: Field required type: missing error_code: validation_error retryable: false status: 422 timestamp: '2026-03-31T12:00:00+00:00' title: Validation Error type: https://closient.com/docs/errors/validation_error - detail: Rate limit exceeded. Please try again later. error_code: rate_limited retry_after: 31 retryable: true status: 429 timestamp: '2026-03-31T12:00:00+00:00' title: Rate Limited type: https://closient.com/docs/errors/rate_limited properties: type: description: URI reference identifying the error type. title: Type type: string title: description: Short human-readable summary of the error. title: Title type: string status: description: HTTP status code. title: Status type: integer detail: description: Human-readable explanation of this specific occurrence. title: Detail type: string error_code: description: Machine-readable error code (e.g. not_found, unauthorized). title: Error Code type: string retryable: default: false description: Whether retrying the same request can succeed. title: Retryable type: boolean timestamp: description: ISO 8601 timestamp of when the error occurred. title: Timestamp type: string retry_after: anyOf: - type: integer - type: 'null' description: Seconds to wait before retrying (when applicable). title: Retry After owner_action_required: anyOf: - type: boolean - type: 'null' description: Whether the error requires account owner intervention. title: Owner Action Required details: description: Additional context (validation errors, etc.). title: Details required: - type - title - status - detail - error_code - timestamp title: ErrorOut type: object OrgExportStatusEnum: description: >- Lifecycle of an export job. Mirrors ``data_export.models.OrgExportStatus``. enum: - pending - processing - completed - failed title: OrgExportStatusEnum type: string OrgExportArchiveFormatEnum: description: >- Archive container. Mirrors ``data_export.models.OrgExportArchiveFormat``. enum: - zip - tar.gz title: OrgExportArchiveFormatEnum type: string OrgExportSectionOut: description: One section's outcome, lifted from the archive manifest. examples: - binary_count: 240 key: products record_count: 120 status: ok properties: key: description: Section identifier, e.g. 'organization', 'products'. title: Key type: string status: description: 'Section outcome: ''ok'', ''empty'', ''partial'', or ''error''.' title: Status type: string record_count: description: Number of structured records the section wrote. title: Record Count type: integer binary_count: anyOf: - type: integer - type: 'null' description: Number of binary asset files the section wrote, if any. title: Binary Count error: anyOf: - type: string - type: 'null' description: Error message if the section failed (best-effort isolation). title: Error required: - key - status - record_count title: OrgExportSectionOut type: object securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````