Skip to main content
GET
List opportunities in the caller's tenant with optional filtering and pagination.

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:1

Page number, 1-indexed. Clamped to >= 1.

per_page
integer
default:50

Results per page. Clamped to the range 1-100 (values outside are silently capped, not rejected).

name
string | null

Case-insensitive substring match on opportunity name.

opportunity_type_uuid
string | null

Filter by opportunity type UUID (call GET /v1/opportunity-types to discover valid values).

opportunity_stage_uuid
string | null

Filter by opportunity stage UUID (inspect stage.uuid on existing records).

opportunity_stage_uuids
string | null

Comma-separated list of opportunity stage UUIDs (IN filter, e.g. for 'Diligence or later').

search
string | null

Fuzzy search across the opportunity name and its associated person/company names. Broader than name, which only matches the opportunity's own name field.

owner_user_uuid
string | null

Comma-separated user UUID(s); filters by the opportunity owner.

include_no_owner
boolean
default:false

Include opportunities with no owner (owner is null).

intro_person_uuid
string | null

Filter by the intro person's UUID.

related_company_uuid
string | null

Return parent opportunities that have a sub-opportunity associated with this company UUID.

related_person_uuid
string | null

Return parent opportunities that have a sub-opportunity associated with this person UUID.

parent_uuid
string | null

Return only the sub-opportunities of this parent opportunity UUID.

hierarchy_type
enum<string> | null

'PARENT' for top-level opportunities only, 'CHILD' for sub-opportunities only. Ignored when parent_uuid is set.

Available options:
PARENT,
CHILD
company_uuid
string | null

Comma-separated company UUID(s); returns opportunities associated with any of them.

person_uuid
string | null

Comma-separated person UUID(s); returns opportunities associated with any of them.

value_from
integer | null

Minimum value, inclusive.

value_to
integer | null

Maximum value, inclusive.

probability_from
integer | null

Minimum probability, inclusive.

probability_to
integer | null

Maximum probability, inclusive.

updated_after
string | null

ISO 8601 date/datetime; only return opportunities updated at or after this time.

updated_before
string | null

ISO 8601 date/datetime; only return opportunities updated at or before this time.

source_date_from
string | null

ISO 8601 date (YYYY-MM-DD). Must be paired with source_date_to — both are required together.

source_date_to
string | null

ISO 8601 date (YYYY-MM-DD). Must be paired with source_date_from — both are required together.

last_activity_date_from
string | null

ISO 8601 datetime. Must be paired with last_activity_date_to — both are required together.

last_activity_date_to
string | null

ISO 8601 datetime. Must be paired with last_activity_date_from — both are required together.

sort_by
enum<string> | null

Field to sort by. Valid values: 'name', 'created_at', 'updated_at', 'value', 'weighted_value', 'probability', 'source_date', 'intro_date', 'last_activity_date', 'details', 'next_step', 'stage' (pipeline stage order), 'owner' (by name), 'intro_person' (by name), 'days_in_stage', 'notes_and_files_count'

Available options:
name,
created_at,
updated_at,
value,
weighted_value,
probability,
source_date,
intro_date,
last_activity_date,
details,
next_step,
stage,
owner,
intro_person,
days_in_stage,
notes_and_files_count
order
enum<string>
default:asc

Sort order. Valid values: 'asc' (ascending) or 'desc' (descending)

Available options:
asc,
desc

Response

200 - application/json

Paginated list of opportunities.

items
OpportunityResponse · object[]
required
page
integer
required
per_page
integer
required
total
integer
required
custom_field_mapping
CustomFieldMapping · object | null
total_value
integer | null
total_weighted_value
integer | null