Opportunities - API Documentation

Retrieve all

Endpoint

GET https://leads.qreq.com/api/opportunities

Parameters	Details	Description
search	OptionalString	Search by name or description
account_id	OptionalInteger	Filter by account ID
opportunity_stage_id	OptionalInteger	Filter by opportunity stage ID
opportunity_source_id	OptionalInteger	Filter by opportunity source ID
status	OptionalString	Filter by status (active/inactive)
assigned_to	OptionalInteger	Filter by assigned user ID
sort_field	OptionalString	Field to sort by
sort_direction	OptionalString	Sort direction (asc/desc)
per_page	OptionalInteger	Pagination limit

Example

curl --request GET \
--url 'https://leads.qreq.com/api/opportunities?search=Test&status=active&per_page=10' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "Opportunities retrieved successfully.", "data": { "current_page": 1, "data": [ { "id": 1, "name": "Opportunity 1", "description": "Description", "amount": 5000, "close_date": "2025-12-31", "status": "active", "account": {"id": 1, "name": "Account 1"}, "contact": {"id": 2, "name": "Contact 1"}, "opportunityStage": {"id": 1, "name": "Qualification"}, "opportunitySource": {"id": 1, "name": "Referral"}, "assignedUser": {"id": 3, "name": "John Doe"}, "products": [] } ], "per_page": 10, "total": 1 } }

Retrieve one

Endpoint

GET https://leads.qreq.com/api/opportunities/{opportunity_id}

Example

curl --request GET \
--url 'https://leads.qreq.com/api/opportunities/{opportunity_id}' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "Opportunity retrieved successfully.", "data": { "opportunity": { "id": 1, "name": "Opportunity 1", "description": "Description", "amount": 5000, "close_date": "2025-12-31", "status": "active", "account": {"id": 1, "name": "Account 1"}, "contact": {"id": 2, "name": "Contact 1"}, "opportunityStage": {"id": 1, "name": "Qualification"}, "opportunitySource": {"id": 1, "name": "Referral"}, "assignedUser": {"id": 3, "name": "John Doe"}, "products": [] }, "meetings": [], "activities": [] } }

Create

Endpoint

POST https://leads.qreq.com/api/opportunities

Parameters	Details	Description
name	RequiredString	Opportunity name
description	OptionalString	Opportunity description
amount	OptionalInteger	Opportunity amount
close_date	OptionalString	Close date (YYYY-MM-DD)
notes	OptionalString	Additional notes
account_id	RequiredInteger	Related account ID
contact_id	OptionalInteger	Related contact ID
opportunity_stage_id	RequiredInteger	Stage ID
opportunity_source_id	RequiredInteger	Source ID
status	OptionalString	Status (active/inactive)
assigned_to	OptionalInteger	Assign to user ID
products	OptionalArray	Products array (product_id, quantity, unit_price)

Example

curl --request POST \
--url 'https://leads.qreq.com/api/opportunities' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "New Opportunity", "description": "Description here", "amount": 5000, "close_date": "2025-12-31", "account_id": 1, "contact_id": 2, "opportunity_stage_id": 1, "opportunity_source_id": 1, "status": "active", "products": [ {"product_id": 1, "quantity": 2, "unit_price": 2500} ] }'

Response example

{ "status": "success", "message": "Opportunity created successfully.", "data": { "id": 1, "name": "New Opportunity", "description": "Description here", "amount": 5000, "close_date": "2025-12-31", "status": "active", "account_id": 1, "contact_id": 2, "opportunity_stage_id": 1, "opportunity_source_id": 1, "created_by": 33, "assigned_to": 33, "products": [] } }

Update

Endpoint

PUT https://leads.qreq.com/api/opportunities/{opportunity_id}

Example

curl --request PUT \
--url 'https://leads.qreq.com/api/opportunities/{opportunity_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "Updated Opportunity", "description": "Updated description", "amount": 6000, "close_date": "2026-01-31", "account_id": 1, "contact_id": 2, "opportunity_stage_id": 2, "opportunity_source_id": 1, "status": "active", "products": [ {"product_id": 1, "quantity": 3, "unit_price": 2000} ] }'

Response example

{ "status": "success", "message": "Opportunity updated successfully.", "data": { "id": 1, "name": "Updated Opportunity", "description": "Updated description", "amount": 6000, "close_date": "2026-01-31", "status": "active", "account_id": 1, "contact_id": 2, "opportunity_stage_id": 2, "opportunity_source_id": 1, "created_by": 33, "assigned_to": 33, "products": [] } }

Delete

Endpoint

DELETE https://leads.qreq.com/api/opportunities/{opportunity_id}

Example

curl --request DELETE \
--url 'https://leads.qreq.com/api/opportunities/{opportunity_id}' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "Opportunity deleted successfully." }

Toggle Status

Endpoint

PATCH https://leads.qreq.com/api/opportunities/{opportunity_id}/toggle-status

Example

curl --request PATCH \
--url 'https://leads.qreq.com/api/opportunities/{opportunity_id}/toggle-status' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "Opportunity status updated successfully.", "data": { "id": 1, "status": "inactive" } }

Delete Activities

Endpoint

DELETE https://leads.qreq.com/api/opportunities/{opportunity_id}/activities

Example

curl --request DELETE \
--url 'https://leads.qreq.com/api/opportunities/{opportunity_id}/activities' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "All activities deleted successfully." }

Delete Activity

Endpoint

DELETE https://leads.qreq.com/api/opportunities/{opportunity_id}/activities/{activity_id}

Example

curl --request DELETE \
--url 'https://leads.qreq.com/api/opportunities/{opportunity_id}/activities/{activity_id}' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "Activity deleted successfully." }

Update Status

Endpoint

PATCH https://leads.qreq.com/api/opportunities/{opportunity_id}/update-status

Example

curl --request PATCH \
--url 'https://leads.qreq.com/api/opportunities/{opportunity_id}/update-status' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "opportunity_stage_id": 2 }'

Response example

{ "status": "success", "message": "Opportunity status updated successfully.", "data": { "id": 1, "opportunity_stage_id": 2 } }