Get all opportunities with filtering options

GET

https://api.channelautomation.com/api/pipeline/opportunities

Authorization

bearerAuth
bearerAuth
required

Query parameters

workspace_id
optional
string
Filter by workspace ID
pipeline_id
optional
string
Filter by pipeline ID

format: uuid
stage_id
optional
string
Filter by stage ID

format: uuid
contact_id
optional
string
Filter by contact ID

format: uuid
priority
optional
low
or
medium
or
high
Filter by priority
is_closed
optional
boolean
Filter by closed status
page
optional
integer
Page number for pagination

default: 1
limit
optional
integer
Items per page

maximum: 100 · default: 50

Returns

200

List of opportunities

JSON

success
optional
boolean
data
optional
array of
object
- id
  optional
  string
  Unique opportunity identifier
  
  format: uuid
- title
  optional
  string
  Title of the opportunity
- description
  optional
  string
  Description of the opportunity
- contact_id
  optional
  string
  Associated contact ID
  
  format: uuid
- company_id
  optional
  string
  Associated company ID
  
  format: uuid
- workspace_id
  optional
  string
  Workspace ID
- stage_id
  optional
  string
  Current stage ID
  
  format: uuid
- pipeline_id
  optional
  string
  Pipeline ID
  
  format: uuid
- amount
  optional
  number
  Opportunity value amount
- currency
  optional
  string
  Currency code
- probability
  optional
  integer
  Success probability percentage
- priority
  optional
  low
  or
  medium
  or
  high
  Priority level
- expected_close_date
  optional
  string
  Expected closing date
  
  format: date-time
- tags
  optional
  array of
  string
  Tags associated with this opportunity
- created_by
  optional
  string
  User ID who created the opportunity
  
  format: uuid
- assigned_to
  optional
  string
  User ID the opportunity is assigned to
  
  format: uuid
- created_at
  optional
  string
  Creation timestamp
  
  format: date-time
- updated_at
  optional
  string
  Last update timestamp
  
  format: date-time
- is_closed
  optional
  boolean
  Whether the opportunity is closed
- is_won
  optional
  boolean
  or null
  Whether the opportunity was won (null if not closed)
}
pagination
optional
object
- page
  optional
  integer
- limit
  optional
  integer
- total
  optional
  integer
- totalPages
  optional
  integer
- hasNext
  optional
  boolean
- hasPrev
  optional
  boolean
}

401

Unauthorized

500

Internal server error

{ "success": true, "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf", "workspace_id": "string", "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670", "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0", "amount": 0, "currency": "string", "probability": 0, "priority": "low", "expected_close_date": "2019-08-24T14:15:22Z", "tags": [ "string" ], "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4", "assigned_to": "b9f52997-ff03-4166-bbff-22fd35e12939", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "is_closed": true, "is_won": true } ], "pagination": { "page": 0, "limit": 0, "total": 0, "totalPages": 0, "hasNext": true, "hasPrev": true } }