DocumentsList document types

List document types

GET/firm-partners/workspace/document-types

Returns the document types this workspace can use, grouped by type group.

Includes COUNT's built-in types for the workspace's country and the custom types the workspace created in COUNT. A built-in group with no type for the workspace's country is left out. `isSystem` is true for COUNT's built-in types and groups; `aiDescription` (the instructions COUNT's classifier follows) appears on the workspace's own types only. Not paginated.

HMAC signature only

Headers

count-workspace-iduuidrequired

UUID 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.

Responses

200Type groups with their types under data.documentTypeGroups.
400The `count-workspace-id` header is missing.
401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot
403The 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. Troubleshoot
404No 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). Troubleshoot
GEThttps://api.getcount.com/firm-partners/workspace/document-types
Request
import 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/document-types';
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/document-types`, {
  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());
Response · 200
{
  "status": "success",
  "data": {
    "documentTypeGroups": [
      {
        "id": "a11040f7-ecda-43ee-917d-21c83ef278c0",
        "code": "legal_and_corporate",
        "name": "Legal and Corporate",
        "description": "Entity, licenses, contracts, and legal matters",
        "isSystem": true,
        "documentTypes": [
          {
            "id": "b96cbac4-95f8-46cd-b0d7-a9ab92299ce0",
            "code": "contract",
            "name": "Contract",
            "description": "Commercial agreement with a customer, vendor, or partner",
            "isSystem": true
          }
        ]
      }
    ]
  }
}