Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Folders

Return the data of the contents of a Folder

Return the data of the contents of a Folder.

Note: offset pagination is not supported for this endpoint. Use cursor pagination if you're looking to paginate through the results.

get/folders/list.json

Query parameters

contact_idinteger

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

created_sincestring date-time

Filter Folder 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 Folder. The list will be filtered to include only the Folder 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 Folder records to those having the specified unique identifiers.

include_deletedboolean

Allow trashed Folder record to be included.

limitinteger

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

matter_idinteger

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

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

Orders the Folder 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.

When returning the data of the contents of a Folder, the keyword null is not valid for this field. If no Folder is provided, it will default to the account's root Folder.

When returning the data for all Folders, use the keyword null to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.

querystring

Wildcard search for name matching the given string.

scope'descendants' | 'children'

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

show_uncompletedboolean

Allow Folder record being uploaded to be included.

updated_sincestring date-time

Filter Folder 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