Skip to main content
List customer document metadata

Authorizations

X-API-Key
string
header
required

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

Path Parameters

customerId
string
required

Query Parameters

cursor
string

Opaque cursor returned as nextCursor from the previous page.

limit
integer
default:25

Maximum number of records to return. Defaults to 25.

Required range: 1 <= x <= 100
type
string

Return only documents with this type.

updatedAfter
string<date-time>

Return only records updated at or after this RFC 3339 timestamp. Use it to recover from missed webhooks by replaying a window of changes.

Response

Documents returned

data
object[]
required
nextCursor
string | null
required
hasMore
boolean
required