API ReferenceScans

List scans

List your scan and open-and-scan requests, with filtering, search and pagination

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_… in production or usgmk_test_… in the sandbox.

Query parameters

limitintegerOptional<=9007199254740991Defaults to 25
Page size, capped at 100.
cursorstringOptional>=1 character

Opaque page cursor — the next_cursor of the previous response. Omit for the first page.

statuslist of enumsOptional
typelist of enumsOptional

scan (scan the item) or open (open it and scan the contents).

Allowed values:
mail_idstringOptionalformat: "^\d+$"
searchstringOptional1-100 characters
sortenumOptional
Allowed values:
scannedenumOptional
Allowed values:

Response

datalist of objects
next_cursorstring or null

Pass as ?cursor= to fetch the next page. Null on the last page.

total_countinteger0-9007199254740991
Total number of items matching this query across all pages.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error