Firm, Clients & MembersGet firm details

Get firm details

GET/firm-partners/firm/details

Returns the profile of the firm the API key belongs to.

Every field except `name` may be null. Needs the `firm:read` scope.

HMAC signature only

Responses

200The firm profile.
401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot
403The API key is inactive, its scope does not cover this route, or it is limited to selected client workspaces and the route is firm-wide. Troubleshoot
404The firm no longer exists.
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/firm/details
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 = '/firm/details';
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/firm/details`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
  },
});

console.log(await response.json());
Response · 200
{
  "status": "success",
  "message": "Success on fetching firm details.",
  "data": {
    "firm": {
      "id": "0b7e5c2a-4f1d-4a8e-9c3b-6d2e1f0a9b8c",
      "name": "Northwind Accounting",
      "email": "hello@northwind.example",
      "phone": "+1 415 555 0100",
      "website": "https://northwind.example",
      "logoUrl": null,
      "numberOfEmployees": 12,
      "tagline": "Books closed by the 5th"
    }
  }
}