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.

Recipes
🦉
Create an opportunity in sales module
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns

Returns the list of opportunities or returns the error in case of failure.

Response Details

NameTypeDescription
opportunity_idguidA unique identifier of the opportunity
opportunity_nointegerNumber of the opportunity.
opportunity_titlestringTitle given to the opportunity
center_namestringName of the center.
sales_ownerstringName of the owner.
stage_namestringName of the stage.
creation_datedatetimeDate on which the opportunity is created.
followup_datedatetimeDate on which a followup call is planned
pricedouble?Offered price, gives listed price if the offered price doesn't exist or zero
call_statusstringStatus of the call.
guestobjectContains details of the guest.
guest.guest_idguidUnique Id of the guest.
guest.guest_namestringName of the guest.
guest.guest_codestringCode used to identify the guest.
guest.phone_numberstringPhone number of the guest.
invoicesarraycontains list of invoice objects created using this opportunity
invoices.invoice_idguidunique identifier of the invoice
invoices.invoice_nostringunique number given to the invoice
Query Params
string

Unique identifier of the center.

int32

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

int32

The number of records in a single page.

string

Keywords for the retrieving the opportunities.

string

Unique identifier of the guest.

string

Unique identifier of the call disposition.

date

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

date

Date till which the API should retrieve all the opportunities.

date

Date when the opportunities were created.

date

Date of creation of the opportunities.

string

Unique identifier of the status of the opportunity.

string

Identifier of the priority of the opportunity.

string

Identifier of the source of the opportunity.

date

Last modified date of the opportunity.

date

Last modified date of the opportunity.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json