List all Documents

get

https://api.inscribe.ai/api/v2/customers/{customer_id}/documents

Returns a list of all of your documents for a customer. The list is sorted by creation date, with the most recently created documents appearing first.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

uuid

required

The Inscribe customer id.

Query Params

customer_ids

uuid

A comma separated list of customer UUIDs. Filter documents by specific customer IDs.

customer_statuses

string

enum

Filter documents by customer status.

Allowed:

document_ids

uuid

A comma separated list of document UUIDs. Filter documents by specific document IDs.

document_types

string

enum

Filter documents by document type

end_date

date

Filter documents created before this date.

file_types

string

enum

Filter documents by file type.

Allowed:

is_fraudulent

boolean

deprecated

Filter documents by fraud status. Warning This field is deprecated.

limit

int64

1 to 50

Set a limit on the number of documents to be returned per page. The limit can range between 1 and 50, the default is 15.

order

string

enum

Sort order for documents. Use -created_at for descending order by creation date.

Allowed:

page

int64

≥ 1

Indicate which page of the document list to return, the default is 1.

string

A search query to filter documents.

start_date

date

Filter documents created on or after this date.

200Returns back a list of Document objects.

400You have provided incorrect data.

403You do not have permission to access this resource.

404The specified resource was not found.

429Too many requests. The request has been rate limited. For more information, visit our documentation on rate limiting.