v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Opportunities

Get opportunities

Retrieve a list of opportunities based on provided filters

Required scopes: flex.community.opportunities.read

get/api/v2/organizations/{orgSlug}/opportunities

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Example:6a59d07f856fad4ee41952d1

Filter by the id of the opportunity

companystring

Example:6a59d07f856fad4ee41952d2

Filter by company id.

memberstring

Example:6a59d07f856fad4ee41952d3

Filter by member id.

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "properties": {
        "customProperty1": "value1",
        "customProperty2": "value2"
      },
      "_id": "6a59d07f856fad4ee41952d4",
      "name": "John Doe",
      "company": "6a59d07f856fad4ee41952d5",
      "member": "6a59d07f856fad4ee41952d6",
      "status": "6a59d07f856fad4ee41952d7",
      "probability": 10,
      "startDate": "2024-02-08T10:00:00.000Z",
      "dealSize": 500,
      "membersCount": 5,
      "createdAt": "2022-02-07T10:03:33.169Z",
      "createdBy": "6a59d07f856fad4ee41952dc",
      "modifiedAt": "2022-02-08T10:03:33.169Z",
      "modifiedBy": "6a59d07f856fad4ee41952dd"
    }
  ]
}