List documents
/firm-partners/workspace/documentsReturns a paginated list of documents with optional UUID filters.
Headers
count-workspace-iduuidrequiredUUID of the client workspace to act on. It must be one of your firm's client workspaces (or the firm's own workspace) and within the API key's client workspaces.
Query parameters
pageintegeroptionalPage number for pagination. The first page is 1.
limitintegeroptionalRecords to return per page.
vendorUuidsstringoptionalComma-separated vendor UUIDs to filter by.
customerUuidsstringoptionalComma-separated customer UUIDs to filter by.
personUuidsstringoptionalComma-separated person UUIDs to filter by.
projectUuidsstringoptionalComma-separated project UUIDs to filter by.
documentTypeUuidsstringoptionalComma-separated document type UUIDs to filter by. A type the workspace cannot use, or a malformed UUID, returns 404.
documentTypeGroupUuidsstringoptionalComma-separated document type group UUIDs. Matches every type in those groups that the workspace can use. Sent with `documentTypeUuids`, a document must match both.
startDatedateoptionalFilter documents created on or after this date.
endDatedateoptionalFilter documents created on or before this date.
Responses
200Paginated document list. `pagination.total` counts every matching document.400The `count-workspace-id` header is missing.401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot403The key is inactive or its scope does not allow this request, the workspace is not managed by your firm or is outside the key's client workspaces, the workspace has no active subscription, or it is portal-only and the route needs bookkeeping. Troubleshoot404No workspace exists with the `count-workspace-id` UUID.429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). Troubleshoothttps://api.getcount.com/firm-partners/workspace/documentsimport crypto from 'node:crypto';
const BASE_URL = 'https://api.getcount.com';
const CLIENT_ID = process.env.COUNT_CLIENT_ID;
const CLIENT_SECRET = process.env.COUNT_CLIENT_SECRET;
const method = 'GET';
const signingPath = '/workspace/documents';
const timestamp = Math.floor(Date.now() / 1000).toString();
const bodyString = '';
const bodyHash = '';
const baseString = `${method}:${signingPath}:${timestamp}:${bodyHash}`;
const signature = crypto.createHmac('sha256', CLIENT_SECRET).update(baseString).digest('hex');
const response = await fetch(`${BASE_URL}/firm-partners/workspace/documents`, {
method,
headers: {
'x-client-id': CLIENT_ID,
'x-timestamp': timestamp,
'x-signature': signature,
'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
},
});
console.log(await response.json());{
"status": "success",
"message": "Success on fetching documents",
"data": {
"documents": [
{
"id": "d9e0f1a2-b3c4-5678-def0-890123456789",
"fileName": "contract-acme-2026.pdf",
"originalFileName": "contract-acme-2026.pdf",
"isPasswordProtected": false,
"isPrivate": false,
"vendor": null,
"customer": {
"id": "dfa3219e-6af8-4c53-997a-037534f63a35",
"customer": "Acme Corporation"
},
"person": null,
"project": null,
"documentType": {
"id": "b96cbac4-95f8-46cd-b0d7-a9ab92299ce0",
"code": "contract",
"name": "Contract",
"documentTypeGroup": {
"id": "a11040f7-ecda-43ee-917d-21c83ef278c0",
"code": "legal_and_corporate",
"name": "Legal and Corporate"
}
},
"documentTypeSource": "ai",
"periodStartDate": "2026-03-01",
"periodEndDate": "2027-02-28",
"periodSource": "ai",
"uploadedBy": {
"id": "6b7c8d9e-0f1a-4b2c-9d3e-4f5a6b7c8d9e",
"firstName": "Jane",
"lastName": "Smith"
},
"createdAt": "2026-03-01T09:00:00.000Z",
"updatedAt": "2026-03-01T09:00:00.000Z"
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 20,
"totalPages": 1
}
}
}