Skip to main content
GET
List Inbox Documents

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

ocrStatus
enum<string>[]

Filter on OCR status.

Available options:
None,
Pending,
Completed,
Failed,
Applied
authorIds
integer<int32>[]

Filter on author user IDs.

purchaseIds
integer<int32>[]

Filter on purchase IDs.

disputeIds
integer<int32>[]

Filter on dispute IDs.

operations
enum<string>[]

Filter on user operations (roles).

Available options:
Buyer,
PurchasingManager,
Accountant,
Admin,
Payer,
PurchaseReader,
InvoicingManager
establishment.ids
integer<int32>[]

Filter on establishment IDs.

establishment.includeNull
boolean

Include documents with no establishment.

sort
null | string

Sort order. Prefix with - for descending. Comma-separated for multiple properties.

fields.root
enum<string>[]

Include root collection fields (paging).

Available options:
prev,
next,
count
page

Page selection. Page tokens can be retrieved by adding ?fields.root=next,prev on your GET collections requests.

limit
integer

Page size (max 100).

Required range: 0 <= x <= 100

Response

200 - application/json

OK

items
inbox-document · object[]
required
prev
next
count
integer<int32>
Required range: x >= 0