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
    • Clients/Departments
        • POSTCreate an opportunity
        • DELDelete an opportunity
        • GETGet an opportunity by GUID
        • GETList opportunities
        • PUTUpdate an opportunity
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
LogoLogo
Get SupportGet a demo
Public API Reference (Beta)OpportunitiesCore

Get an opportunity by GUID

GET
https://app.brightmove.com/ATS/api/v1/opportunities/:guid
GET
/ATS/api/v1/opportunities/:guid
$curl https://app.brightmove.com/ATS/api/v1/opportunities/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
>     -H "X-Brightmove-Company-ApiKey: <apiKey>"
200Retrieved
1{}
Returns the full detail of a single sales opportunity including its stage, estimated value, assigned sales representatives, and associated contacts.
Was this page helpful?
Previous

List opportunities

Next
Built with

Authentication

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

Path parameters

guidstringRequired
Stable public identifier of the opportunity

Response

Opportunity found and returned