List opportunities
Returns a paginated list of opportunities visible to the tenant ring.
Filter parameters (all optional):
- name: Case-insensitive substring match on the opportunity’s own name
- search: Fuzzy search across name and associated person/company names
- opportunity_type_uuid: Filter by opportunity type UUID (use GET /v1/opportunities
to inspect
type.uuidon existing records) - opportunity_stage_uuid: Filter by a single stage UUID
- opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter)
- owner_user_uuid: Comma-separated user UUID(s); filters by owner
- include_no_owner: Also include opportunities with no owner assigned
- intro_person_uuid: Filter by the intro person’s UUID
- related_company_uuid / related_person_uuid: parent opportunities that have a sub-opportunity associated with this entity
- parent_uuid: Return only sub-opportunities of this parent UUID
- hierarchy_type: ‘PARENT’ or ‘CHILD’ (ignored if parent_uuid is set)
- company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities associated with any of them
- value_from / value_to, probability_from / probability_to: inclusive range filters
- updated_after / updated_before: ISO 8601 date/datetime range on updated_at
- source_date_from / source_date_to: ISO 8601 dates, required together
- last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required together
Sort parameters:
- sort_by: 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: asc | desc (default: asc)
Pagination:
- page: Page number (default: 1)
- per_page: Results per page (default: 50)
The response also includes total_value/total_weighted_value: sums of
value/weighted_value across the full filtered set, not just the page.
Authorizations
Query Parameters
Page number, 1-indexed. Clamped to >= 1.
Results per page. Clamped to the range 1-100 (values outside are silently capped, not rejected).
Case-insensitive substring match on opportunity name.
Filter by opportunity type UUID (call GET /v1/opportunity-types to discover valid values).
Filter by opportunity stage UUID (inspect stage.uuid on existing records).
Comma-separated list of opportunity stage UUIDs (IN filter, e.g. for 'Diligence or later').
Fuzzy search across the opportunity name and its associated person/company names. Broader than name, which only matches the opportunity's own name field.
Comma-separated user UUID(s); filters by the opportunity owner.
Include opportunities with no owner (owner is null).
Filter by the intro person's UUID.
Return parent opportunities that have a sub-opportunity associated with this company UUID.
Return parent opportunities that have a sub-opportunity associated with this person UUID.
Return only the sub-opportunities of this parent opportunity UUID.
'PARENT' for top-level opportunities only, 'CHILD' for sub-opportunities only. Ignored when parent_uuid is set.
PARENT, CHILD Comma-separated company UUID(s); returns opportunities associated with any of them.
Comma-separated person UUID(s); returns opportunities associated with any of them.
Minimum value, inclusive.
Maximum value, inclusive.
Minimum probability, inclusive.
Maximum probability, inclusive.
ISO 8601 date/datetime; only return opportunities updated at or after this time.
ISO 8601 date/datetime; only return opportunities updated at or before this time.
ISO 8601 date (YYYY-MM-DD). Must be paired with source_date_to — both are required together.
ISO 8601 date (YYYY-MM-DD). Must be paired with source_date_from — both are required together.
ISO 8601 datetime. Must be paired with last_activity_date_to — both are required together.
ISO 8601 datetime. Must be paired with last_activity_date_from — both are required together.
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'
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 Sort order. Valid values: 'asc' (ascending) or 'desc' (descending)
asc, desc