For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get SupportGet a demo
  • Get Started
    • Welcome
    • Quickstart
  • Webhooks
    • Introduction
    • Creating a Webhook
    • Available Webhooks
  • Public API Reference (Beta)
    • Applicants/Candidates
    • Contacts/Managers
        • POSTCreate a client office
        • DELDelete a client office
        • GETGet a client office by GUID
        • GETList client offices
        • PUTUpdate a client office
    • Clients/Departments
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
LogoLogo
Get SupportGet a demo
Public API Reference (Beta)Office/LocationCore

List client offices

GET
https://app.brightmove.com/ATS/api/v1/client-offices
GET
/ATS/api/v1/client-offices
$curl https://app.brightmove.com/ATS/api/v1/client-offices \
>     -H "X-Brightmove-Company-ApiKey: <apiKey>"
200Retrieved
1{}
Was this page helpful?
Previous

Update a client office

Next
Built with

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Query parameters

pageintegerOptionalDefaults to 0
sizeintegerOptionalDefaults to 25
qstringOptional

Response

OK