Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Documents

Return the data for all Documents

Outlines the parameters, optional and required, used when requesting the data for all Documents

get/documents.json

Query parameters

contact_idinteger

The unique identifier for a single Contact. Use the keyword null to match those without a Document. The list will be filtered to include only the Document records with the matching property.

created_sincestring date-time

Filter Document records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

document_category_idinteger

The unique identifier for a single DocumentCategory. Use the keyword null to match those without a Document. The list will be filtered to include only the Document records with the matching property.

external_property_namestring

Filter records to only those with the given external property(s) name set.

e.g. ?external_property_name=Name

external_property_valuestring

Filter records to only those with the given external property(s) value set. Requires external property name as well.

e.g. ?external_property_name=Name&external_property_value=Value

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter Document records to those having the specified unique identifiers.

include_deletedboolean

Allow trashed Document record to be included.

limitinteger

A limit on the number of Document records to be returned. Limit can range between 1 and 200. Default: 200.

lockedboolean

Filter Document records to those that are locked.

matter_idinteger

The unique identifier for a single Matter. Use the keyword null to match those without a Document. The list will be filtered to include only the Document records with the matching property.

order'created_at(asc)' | 'created_at(desc)' | 'document_number(asc)' | 'document_number(desc)' | 'id(asc)' | 'id(desc)' | 'name(asc)' | 'name(desc)' | 'received_at(asc)' | 'received_at(desc)' | 'updated_at(asc)' | 'updated_at(desc)'

Orders the Document records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

parent_idinteger

The unique identifier for a single Folder. Use the keyword null to match those without a Document. The list will be filtered to include only the Document records with the matching property.

querystring

Wildcard search for name matching the given string.

scope'descendants' | 'children'

Filters Document record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is children.

show_uncompletedboolean

Allow Document record being uploaded to be included.

updated_sincestring date-time

Filter Document records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok