Get Company Documents

get

https://api.zylo.com/v2/companyDocuments

Retrieve a list of company documents. Company documents are created when files are uploaded through the Pending Contracts upload endpoints, attached to contracts, or imported from external systems such as Coupa. Use the status query parameter to filter by processing status: U (uploading — file received, AI extraction in progress), A (active — extraction complete, data available in Pending Contracts), or E (error — extraction failed).

Required Permissions

applications:read AND contracts:read

Rate Limit

basic

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

byte_size

string

File size in bytes.

content_type

string

MIME type of the uploaded file (e.g., application/pdf, image/jpeg).

description

string

Description of the uploaded document.

external_document_id

string

External ID for the document if fetched from an external system (e.g., Coupa).

filename

string

Name of the uploaded file.

string

Unique identifier for the company document.

status

string

enum

Processing status of the document. U = Uploading, A = Active (processed), E = Error.

Allowed:

zylo_created_at

string

Date and time the document was created.

zylo_modified_at

string

Date and time the document was last modified.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok