Skip to main content
GET
Get opportunity by ID

Authorizations

Authorization
string
header
required

JWT authentication for organization-scoped endpoints.

Authorization
string
header
required

API key authentication for public API endpoints. This key is scoped by workspace so a unique key is required per workspace within an organisation.

Path Parameters

orgId
string
required

Organization ID

workspaceId
string
required

Workspace ID

opportunityId
string
required

Opportunity ID

Query Parameters

relationships
string

Comma-separated list of relationships to include in the response

Response

Success

Response containing a single opportunity

data
object
required

Opportunity data