Skip to the page
Chapters

Offices

List offices

GET/api/v1/offices

The offices of the key's organization, in the key's mode (test or live). An office ID is needed to run an eligibility check. All offices are returned: next_cursor is always null.

Needs a key with read permission.

Request

This request takes no parameters and no body.

Response

The offices. Status 200.

Response fields
NameTypeDescription
dataarray of object
data[].idstringAn ID that starts with off_.
data[].objectstringAlways `office`.
data[].namestring
data[].address_line1string
data[].address_line2value
data[].citystring
data[].statestring
data[].postal_codestring
data[].phonestring
data[].npistring
data[].tax_id_last4stringThe last 4 digits of the tax ID. The full tax ID is never returned.
data[].specialtystring
data[].contact_namevalueWho the attachment network contacts about this office; null when not given.
data[].contact_emailvalue
data[].contact_faxvalue
data[].doctor_first_namevalueThe office's primary doctor, for registering with the attachment network.
data[].doctor_last_namevalue
data[].attachment_networkobjectThe office's registration with the attachment network, which it needs before its first attachment is sent.
data[].attachment_network.statestringnot_registered until POST /offices/{id}/register_attachments succeeds (or the first attachment of the office is closed); failed when the network refused it.One of: `not_registered`, `registered`, `failed`.
data[].attachment_network.facility_idvalueThe facility ID the attachment network gave the office.
data[].attachment_network.registered_atstring (date-time) or null
data[].modestringOne of: `test`, `live`.
data[].created_atstring (date-time)
next_cursorvaluePass as cursor to get the next page; null when there is no next page.

Errors

Errors
HTTP statusCodeWhat it means
401UNAUTHORIZEDA valid API key is required. Send it as "Authorization: Bearer <key>".
403PERMISSION_DENIEDThis API key is not allowed to do that.
422INVALID_REQUESTThe request is not valid.
504TIMEOUTThe request took too long to finish. It may still have taken effect: look it up before sending it again with a new Idempotency-Key. What it made is found with GET /api/v1/eligibility?request_id=<this request_id>, and the same filter on /api/v1/claims and /api/v1/attachments (a key with read permission).
500INTERNALSomething went wrong on our side. Quote the request ID if you contact us.

Example

Example request

Shell
curl "https://sandbox.myclaimhouse.com/api/v1/offices" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON
{
  "data": [
    {
      "id": "off_01JM000000E008000000000003",
      "object": "office",
      "name": "Example Family Dental",
      "address_line1": "100 Example Street",
      "address_line2": null,
      "city": "Exampleville",
      "state": "GA",
      "postal_code": "30000",
      "phone": "4045550100",
      "npi": "1999999000",
      "tax_id_last4": "0000",
      "specialty": "general",
      "contact_name": "Pat Example",
      "contact_email": null,
      "contact_fax": null,
      "doctor_first_name": "Riley",
      "doctor_last_name": "Example",
      "attachment_network": {
        "state": "not_registered",
        "facility_id": null,
        "registered_at": null
      },
      "mode": "test",
      "created_at": "2026-01-15T14:00:00+00:00"
    }
  ],
  "next_cursor": null
}