COcoevera
Lead & Opportunity

List opportunities

Returns the opportunities the API application can read, one page at a time.

get/entities/Opportunities

Request

Query parameters

include-deletedboolean

Include soft-deleted records. Lists only; get-by-id refuses it.

firstinteger

Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117.

lastinteger

Return the last N records of the result; together with first, the last N of the first M. Maximum 100.

beforestring

Cursor from page_info.start_cursor, to page backwards. URL-encode it.

afterstring

Cursor from page_info.end_cursor of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space.

expandstring

Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in account_relations.account.

order-bystring

Fields to sort by, comma-separated. A leading - sorts descending, as in -modified; dotted paths sort by related fields.

filterobject

filter[field]=value. Separate several values with a raw comma (OR), as in filter[name]=north,south. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in filter[owner.email]. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space.

filter-opobject

filter-op[field]=operator, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one.

load-onlystring

Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in owner.id. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118.

Response

Page of Opportunity records.

successboolean

True when the request succeeded; false on error.

totalinteger

Number of records that match the request, across all pages.

Example response

{
  "success": true,
  "data": [
    {
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "active_quote_id": "01234567-abcd-dcba-ffff-000000000000",
      "closing_date": "2019-01-01",
      "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
      "description": "string",
      "last_ai_buying_center_applied": "2019-01-01T00:00:00",
      "lead_source_id": "01234567-abcd-dcba-ffff-000000000000",
      "name": "string",
      "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "owner_id": "01234567-abcd-dcba-ffff-000000000000",
      "product_currency_id": "01234567-abcd-dcba-ffff-000000000000",
      "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
      "quick_account_email": "string",
      "quick_account_name": "string",
      "quick_account_phone": "string",
      "quick_contact_name": "string",
      "quick_email": "string",
      "quick_phone": "string",
      "ranking": 1,
      "reason_of_close_description": "string",
      "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
      "step_id": "01234567-abcd-dcba-ffff-000000000000",
      "table_name": "string",
      "unit_id": "01234567-abcd-dcba-ffff-000000000000",
      "revision": 1,
      "value": {
        "currency_id": "01234567-abcd-dcba-ffff-000000000000"
      },
      "status": 1,
      "qualify_date": "2019-01-01T00:00:00",
      "won_date": "2019-01-01T00:00:00",
      "lost_date": "2019-01-01T00:00:00",
      "days_in_step": 1,
      "formatted_name": "string",
      "modified_by_user": "2019-01-01T00:00:00"
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  },
  "total": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.