Skip to main content
GET
Cursor-list opportunities

Authorizations

x-api-key
string
header
required

Personal API key. Requests act as the workspace member who created the key, with that member's current access, and stop working when the key is disabled or its creator leaves the workspace.

Query Parameters

pipeline_id
string
required

Pipeline ID. Required for opportunity reads.

stage_id
string

Optional stage ID.

q
string

Free-text search query.

cursor
string

Opaque pagination cursor returned by a previous page.

limit
integer

Maximum number of records.

Required range: 1 <= x <= 500
fields

Optional fields to include. Accepts a comma-separated string or repeated array values.

Response

Opportunities were returned.

success
boolean
Example:

true

message
string
data
object

Endpoint-specific response payload.