> ## 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. # List capture jobs > List this organization's capture jobs, newest first. Scoped to the caller's organization; another tenant's jobs are never returned. ## OpenAPI ````yaml /openapi/openapi-epcis.json get /epcis/api/2.0/capture openapi: 3.1.0 info: title: EPCIS 2.0 API version: 2.0.0 description: > EPCIS 2.0 event capture and query, scoped to lot-level supply chain traceability and recall containment — not warehouse logistics, cold-chain monitoring, or business-document exchange. Roles claimed: EPCIS 2.0 capture interface server, EPCIS 2.0 data. Not claimed: EPCIS 2.0 query interface server; Query callback interface implementation. Binding: REST over HTTPS. Serialization: JSON and JSON-LD. Vocabulary: GS1 CBV 2.0. XML and EPCIS 1.2 are out of scope by design, not a pending decision (C-5415). 6 of 63 official EPCIS 2.0 REST operations are served, all within the roles claimed above. Full capability declaration: https://docs.closient.com/guides/epcis-conformance ## 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: /epcis/api/2.0/capture: get: tags: - EPCIS 2.0 summary: List capture jobs description: >- List this organization's capture jobs, newest first. Scoped to the caller's organization; another tenant's jobs are never returned. operationId: apps_epcis_api_epcis_list_capture_jobs parameters: - in: query name: perPage schema: default: 30 description: Maximum jobs to return. maximum: 200 minimum: 1 title: Perpage type: integer required: false description: Maximum jobs to return. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CaptureJobListSchema' headers: GS1-EPCIS-Version: schema: type: string description: EPCIS version this server implements. GS1-CBV-Version: schema: type: string description: CBV version this server implements. GS1-Extensions: schema: type: string description: Vendor extensions active on this response. '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '401': description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorOut' application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' headers: GS1-EPCIS-Version: schema: type: string description: EPCIS version this server implements. GS1-CBV-Version: schema: type: string description: CBV version this server implements. GS1-Extensions: schema: type: string description: Vendor extensions active on this response. '403': description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorOut' application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' headers: GS1-EPCIS-Version: schema: type: string description: EPCIS version this server implements. GS1-CBV-Version: schema: type: string description: CBV version this server implements. GS1-Extensions: schema: type: string description: Vendor extensions active on this response. '404': description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '405': description: Method Not Allowed content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '422': description: Unprocessable Content content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - CookieGatedSessionAuth: [] components: schemas: CaptureJobListSchema: description: >- 200 response body for ``GET /capture`` — this organization's capture jobs. Declared as a real schema rather than a bare ``dict`` so the published contract names the envelope key. A spec that says "object" tells a client nothing about what to read out of it, which is the same class of defect C-5413 found across the capture surface. examples: - captureJobs: - captureErrorBehaviour: rollback captureID: f47ac10b-58cc-4372-a567-0e02b2c3d479 createdAt: '2026-08-25T03:40:00+00:00' errors: [] finishedAt: '2026-08-25T03:40:00.812000+00:00' running: false success: true properties: captureJobs: description: Capture jobs owned by the caller's organization, newest first. items: $ref: '#/components/schemas/CaptureAcceptedSchema' title: Capturejobs type: array title: CaptureJobListSchema 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 CaptureAcceptedSchema: description: >- 202 response body for an accepted EPCIS capture (C-5404). Mirrors the GS1 EPCIS 2.0 capture-job resource: ``running`` and ``success`` are the two booleans the standard specifies, and reading them together is what lets a client distinguish "not finished yet" from "finished and failed". The same body is returned by ``GET /capture/{captureID}``, so a client can treat the POST response as its first poll. ``errors`` carries RFC 9457 problem objects. Each has ``sequenceInEPCISDoc`` — the indices of the offending events in the document you submitted — which is what makes a rejection on a large file actionable rather than merely true. examples: - captureErrorBehaviour: rollback captureID: f47ac10b-58cc-4372-a567-0e02b2c3d479 createdAt: '2026-08-25T03:40:00+00:00' errors: - detail: 'Event is missing required field(s): eventTime' sequenceInEPCISDoc: - 2 status: 400 title: Invalid event type: epcisException:ValidationException finishedAt: '2026-08-25T03:40:00.812000+00:00' running: false success: false properties: captureID: description: Identifier of the capture job; poll GET /capture/{captureID}. title: Captureid type: string createdAt: description: ISO-8601 timestamp the job was accepted. title: Createdat type: string finishedAt: anyOf: - type: string - type: 'null' description: ISO-8601 timestamp processing ended; null while running. title: Finishedat running: description: True while the job is still processing. title: Running type: boolean success: description: >- True only when every event in the document was captured. False while running — a job that has not finished is not a success yet. title: Success type: boolean captureErrorBehaviour: description: >- Behaviour applied: ``rollback`` (default) or ``proceed``, from GS1-Capture-Error-Behaviour. title: Captureerrorbehaviour type: string errors: description: RFC 9457 problem objects, each carrying sequenceInEPCISDoc. items: additionalProperties: true type: object title: Errors type: array required: - captureID - createdAt - running - success - captureErrorBehaviour title: CaptureAcceptedSchema type: object securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer CookieGatedSessionAuth: type: apiKey in: cookie name: sessionid ````