Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

List all opportunities

Supply the unique identifier of the center and the fields on which you want to filter the opportunities and this API will return the list of opportunities in that center.

get/v1/opportunities?view_id={center_id}&page_num={page_num}&records={records}&keywords={keywords}&owner={owner}&type={type}&guest_id={guest_id}&disposition_id={disposition_id}&followup_from_date={followup_from_date}&followup_to_date={followup_to_date}&creation_from_date={creation_from_date}&creation_to_date={creation_to_date}&status_id={status_id}&priority_id={priority_id}&source_id={source_id}&last_modified_start_date={last_modified_start_date}&last_modified_end_date={last_modified_end_date}

Query parameters

center_idstring

Unique identifier of the center.

page_numinteger

The number of pages on which you want the opportunity records to be retrieved and displayed.

recordsinteger

The number of records in a single page.

keywordsstring

Keywords for the retrieving the opportunities.

guest_idstring

Unique identifier of the guest.

disposition_idstring

Unique identifier of the call disposition.

followup_from_datestring date

Date of the follow-up from which the API should list all the opportunities.

followup_to_datestring date

Date till which the API should retrieve all the opportunities.

creation_from_datestring date

Date when the opportunities were created.

creation_to_datestring date

Date of creation of the opportunities.

status_idstring

Unique identifier of the status of the opportunity.

priority_idstring

Identifier of the priority of the opportunity.

source_idstring

Identifier of the source of the opportunity.

last_modified_start_datestring date

Last modified date of the opportunity.

last_modified_end_datestring date

Last modified date of the opportunity.

Response

200

total_recordsinteger

Example response

{
  "opportunities": [
    {
      "opportunity_id": "86c10c18-46e2-48a2-97da-08d43e430bde",
      "opportunity_no": 69,
      "opportunity_title": "28-March",
      "center_name": "CME MGM",
      "sales_owner": "Chennai_mgr mgr",
      "stage_name": "Prospect",
      "creation_date": "2018-04-03T04:00:01",
      "followup_date": "2018-04-04T00:00:00",
      "guest": {
        "guest_id": "6dbb590f-5eba-403c-ab04-c5a55dd3521c",
        "guest_name": "Kirity Chennai 2",
        "guest_code": "G892537",
        "phone_number": "9493467838"
      },
      "invoices": [
        {
          "invoice_id": "3d6b3587-a439-4fa9-94e5-3b06cc8a17c7",
          "invoice_no": "Pro17108"
        }
      ]
    }
  ],
  "total_records": 188
}