Offices

Count offices matching filters

POST
/v1/offices/count

Return the exact number of offices matching the given filters. Accepts the same request body as listOffices (pagination and sort are ignored). Use this when you only need a total; to get the matching offices themselves, send the same request body to listOffices.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/offices/count" \  -H "Content-Type: application/json" \  -d '{}'
{
  "lenderNormalizations": [
    {
      "aliasCount": 0,
      "displayName": "string",
      "id": "string",
      "matchedVia": "id",
      "original": "string",
      "totalDocuments": 0
    }
  ],
  "locationNormalizations": [
    {
      "candidates": [
        "string"
      ],
      "confidence": "normalized",
      "displayName": "Saint Louis, MO",
      "field": "city",
      "id": "city_mo_saint-louis",
      "normalized": "Saint Louis",
      "original": "St. Louis",
      "variants": [
        "string"
      ]
    }
  ],
  "total": 48213
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Update the current caller's profile PATCH

Partial update — send only the fields that change; `null` clears one. Returns the account in the same shape as `GET /v1/me`. `email` is NOT updatable here: changing it runs a verification flow. Sending it is a 400, not a silent no-op.

Get office by key with office-level production GET

Next Page