get https://api.zenoti.com/v1/opportunities/
Supply the unique identifier of the opportunity as opportunity_id and this API will retrieve the details of it.
Recipes
🦉
Create an opportunity in sales module
Open Recipe
Response details
| Name | Type | Description |
|---|---|---|
| opportunity | object | Details of the opportunity. |
| opportunity_id | guid | Unique identifier of the opportunity |
| opportunity_title | string | Title of the opportunity. |
| opportunity_description | string | description of the opportunity. |
| opportunity_user_id | guid | Unique Id of the user of the opportunity. |
| opportunity_owner_id | guid | Unique Id of the owner of the opportunity. |
| opportunity_type | string | Type of the opportunity. |
| opportunity_no | int | Number of the opportunity |
| lead_source | object | lead source details of the opportunity |
| lead_source.code | string | unique code for the lead source |
| lead_source.id | guid | unique id for the lead source |
| lead_source.name | string | Name for the lead source |
| creation_date | datetime | Creation date in center time. |
| expected_close_date | datetime | Expected close date in center time. |
| followup_date | datetime | Follow update in center time. |
| created_by | string | Name of the employee who created the opportunity |
| sales_owner | string | Name of the employee who owns the opportunity |
| therapist_id | guid | Unique id of the therapist. |
| ticket_id | guid | Unique id of the ticket. |
| custom_fields | array | Each object contains id, name, and value of the custom fields. |
| optional | object | optional fields. |
| optional.optional_field_1 | string | first optional field. |
| optional.optional_field_2 | string | second optional field. |
| optional.optional_field_3 | string | third optional field. |
| price | object | Details of the price. |
| price.listed_price | double | price listed in the catalog |
| price.offered_price | double | price offered for the opportunity |
| stage | object | Details of the stage |
| stage.stage_name | string | Name of the stage. |
| stage.stage_id | guid | The unique id of the stage. |
| priority | object | Details of the priority |
| priority.priority_name | string | Name of the priority. |
| priority.priority_id | guid | The unique id of the priority. |
| guest | object | Details of the guest |
| guest.guest_id | guid | The Unique id of the guest. |
| guest.guest_name | string | Name of the guest. |
| center | object | Details of the center |
| center.center_id | guid | The unique id of the center. |
| center.center_name | string | Name of the center. |
| disposition | object | Details of the disposition |
| disposition.id | string | Unique id of the disposition |
| disposition.name | string | Name of the disposition. |