Skip to main content
GET
List capture jobs

Authorizations

X-API-Key
string
header
required

Query Parameters

perPage
integer
default:30

Maximum jobs to return.

Required range: 1 <= x <= 200

Response

OK

captureID
string
required

Identifier of the capture job; poll GET /capture/{captureID}.

createdAt
string<date-time>
required

ISO-8601 timestamp the job was accepted.

running
boolean
required

True while the job is still processing.

success
boolean
required

True only when every event in the document was captured. False while running — a job that has not finished is not a success yet.

captureErrorBehaviour
enum<string>
required

Behaviour applied: rollback (default) or proceed, from GS1-Capture-Error-Behaviour.

Available options:
rollback,
proceed
finishedAt
string<date-time>

ISO-8601 timestamp processing ended; absent while the job is running.

errors
RFC7807ProblemResponseBody · object[]

RFC 9457 problem objects, each carrying sequenceInEPCISDoc.