PeopleForce
People

Early access

Company API v4 is the next-generation API and is under active development. Endpoints and fields may still change.

List documents in a folder

Lists documents across employees in one folder. `created_at` is the upload time and `updated_at` the last change, not an invoice date. Download file URLs before their expiry; list the documents again to obtain fresh URLs.

GET
/api/v4/document_folders/{id}/documents

Lists documents across employees in one folder. created_at is the upload time and updated_at the last change, not an invoice date. Download file URLs before their expiry; list the documents again to obtain fresh URLs.

Path Parameters

id*integer
Formatint32

Query Parameters

page?integer

Page number

Formatint32
Range1 <= value
Default1
per_page?integer

Documents per page (maximum 100)

Formatint32
Range1 <= value <= 100
Default50
created_at[gt]?string

created_at after an ISO 8601 timestamp with timezone

Formatdate-time
created_at[gte]?string

created_at on or after an ISO 8601 timestamp with timezone

Formatdate-time
created_at[lt]?string

created_at before an ISO 8601 timestamp with timezone

Formatdate-time
created_at[lte]?string

created_at on or before an ISO 8601 timestamp with timezone

Formatdate-time
updated_at[gt]?string

updated_at after an ISO 8601 timestamp with timezone

Formatdate-time
updated_at[gte]?string

updated_at on or after an ISO 8601 timestamp with timezone

Formatdate-time
updated_at[lt]?string

updated_at before an ISO 8601 timestamp with timezone

Formatdate-time
updated_at[lte]?string

updated_at on or before an ISO 8601 timestamp with timezone

Formatdate-time

Response Body

application/json

curl -X GET "https://example.com/api/v4/document_folders/0/documents"
{  "data": [    {      "id": 0,      "employee_id": 0,      "document_folder_id": 0,      "name": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "type": "file",      "url": "string",      "original_filename": "string",      "content_type": "string",      "byte_size": 0,      "expires_at": "2019-08-24T14:15:22Z"    }  ],  "metadata": {    "page": 0,    "per_page": 0,    "total_pages": 0,    "total_count": 0  }}