Search Opportunities

POST 
/opportunities/search

Search Opportunities based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location Id

querystringrequired

Full-text search query string (max 75 characters)

limitnumberrequired

Maximum number of results to return per page

pagenumberrequired

Page number (0-indexed)

searchAfterstring[]required

Search-after cursor values for deep pagination

additionalDetailsobjectrequired

Flags to include additional related entities in the response

Example (auto)

{
  "locationId": "i2SpAtBVHSVea1sL6oah",
  "query": "[email protected]",
  "limit": 20,
  "page": 0,
  "searchAfter": [
    1625203104328,
    "yWQobCRIhRguQtD2llvk"
  ],
  "additionalDetails": {
    "notes": false,
    "tasks": false,
    "calendarEvents": false
  }
}

application/json

Successful response

application/json

Schema

Schema

opportunitiesobject[]

List of opportunities matching the search criteria

totalnumberrequired

Total number of opportunities matching the query

stageAggregationsobject[]

Per-stage totals when pipeline filter is present

aggregationsobject

Aggregation results keyed by aggregation name

Example (auto)

{
  "opportunities": [],
  "total": 100,
  "stageAggregations": [],
  "aggregations": {}
}