List documents

get

https://integrate.rooflink.com/roof_link_endpoints/api/light/documents/

Retrieves a paginated list of documents accessible to the authenticated employee.

By default, only active (is_active=true), non-soft-deleted documents belonging to the employee's company are returned. Pass all=true to also include inactive documents. Soft-deleted documents are always excluded regardless of the all parameter.

Results are ordered by creation date descending (most recent first).

Query Params

page

integer

≥ 1

Defaults to 1

Page number for pagination. Starts at 1.

page_size

integer

1 to 25

Defaults to 25

Number of items per page. Maximum is 25.

all

boolean

When set to true, includes both active and inactive documents in the response. By default, only active documents are returned.

job

integer

Filter documents by the ID of the associated job. Returns only documents linked to the specified job.

tags

string

Filter documents whose tags array contains this exact value.

related_to

array of strings

Filter documents by one or more related entity references.

Each value must follow the format ClassName{id}, where ClassName is the exact model class name and {id} is the numeric primary key of that entity. Multiple values may be provided as a comma-separated list; when multiple values are given, only documents related to all specified entities are returned (AND logic).

Class name	Entity	Example value
`Job`	Roofing job	`Job501`
`Customer`	Customer	`Customer42`
`Payment`	Payment record	`Payment15`
`WorkOrder`	Work order	`WorkOrder88`
`MatOrder`	Material order	`MatOrder33`
`Crew`	Crew	`Crew7`
`Supplier`	Supplier	`Supplier19`

related_to

is_contract

boolean

Filter for contract documents. When true, returns documents tagged Signed Contract or associated with a contract template.

is_pre_contract

boolean

Filter for pre-contract documents. When true, returns documents tagged Pre-Contracts or associated with a pre-contract template.

string

Case-insensitive substring search on the document name field. Only the document name is searched; tags and other fields are not included in the search.

doc_template

integer

Filter documents by the ID of an associated document template. Matches against both legacy DocTemplate (v1) foreign key and LightDocTemplate (v2) references.

Responses

200Successful response with a paginated list of documents.

400Bad request - The request contains invalid query parameters.

401Unauthorized - The request cannot be authenticated. A valid API key must be provided via the X-API-KEY header.

403Forbidden - The authenticated user does not have the required permissions to access this resource.

429Too many requests - The client has exceeded the rate limits for this endpoint.

503Service unavailable - The total rate limits for the public APIs have been exceeded.