Contacts - API Documentation

Retrieve all

Endpoint

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

Example

curl --request GET \
--url 'https://leads.qreq.com/api/contacts?per_page=10&status=active' \
--header 'X-API-KEY: {api_key}'

Response example

{ "status": true, "data": { "current_page": 1, "data": [ { "id": 1, "name": "Imran Khan", "email": "[email protected]", "phone": "+1-202-555-0183", "position": "Software Engineer", "address": "123 Main Street, New York, NY 10001", "status": "inactive", "account_id": 2, "created_by": 33, "assigned_to": 51, "created_at": "2025-11-03T10:53:20.000000Z", "updated_at": "2025-11-03T10:59:27.000000Z", "account": { "id": 2, "name": "test account", "email": "[email protected]", "phone": "03254152966", "billing_address": "123 Main St", "billing_city": "Karachi", "billing_state": "Sindh", "billing_postal_code": "74000", "billing_country": "Pakistan", "shipping_address": "456 Secondary St", "shipping_city": "Karachi", "shipping_state": "Sindh", "shipping_postal_code": "74001", "shipping_country": "Pakistan", "website": "https://qreq.com/", "account_type_id": 2, "account_industry_id": 2, "status": "active", "created_by": 33, "assigned_to": 51, "created_at": "2025-11-03T10:12:33.000000Z", "updated_at": "2025-11-03T10:12:33.000000Z" }, "assigned_user": null } ], "first_page_url": "https://leads.qreq.com/api/contacts?page=1", "from": 1, "last_page": 1, "last_page_url": "https://leads.qreq.com/api/contacts?page=1", "links": [ { "url": null, "label": "« Previous", "page": null, "active": false }, { "url": "https://leads.qreq.com/api/contacts?page=1", "label": "1", "page": 1, "active": true }, { "url": null, "label": "Next »", "page": null, "active": false } ], "next_page_url": null, "path": "https://leads.qreq.com/api/contacts", "per_page": 10, "prev_page_url": null, "to": 1, "total": 1 } }

Create

Endpoint

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

Parameters	Details	Description
name	RequiredString	Contact name
email	OptionalString	Email address
phone	OptionalString	Phone number
position	OptionalString	Job title / position
address	OptionalString	Contact address
account_id	RequiredInteger	Related account ID
status	OptionalString	Active or inactive. Defaults to active
assigned_to	OptionalInteger	User ID to assign contact

Example

curl --request POST \
--url 'https://leads.qreq.com/api/contacts' \
--header 'X-API-KEY: {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "Jane Doe", "email": "[email protected]", "phone": "9876543210", "position": "Sales Lead", "address": "123 Main St", "account_id": 1, "status": "active", "assigned_to": 2 }'

Response example

{ "status": true, "message": "Contact created successfully.", "data": { "name": "Imran Khan", "email": "[email protected]", "phone": "+1-202-555-0183", "position": "Software Engineer", "address": "123 Main Street, New York, NY 10001", "account_id": 2, "status": "active", "assigned_to": 51, "created_by": 33, "updated_at": "2025-11-03T10:53:20.000000Z", "created_at": "2025-11-03T10:53:20.000000Z", "id": 1 } }

Update

Endpoint

PUT https://leads.qreq.com/api/contacts/{contact_id}

Parameters	Details	Description
name	RequiredString	Contact name
email	OptionalString	Email address
phone	OptionalString	Phone number
position	OptionalString	Job title / position
address	OptionalString	Contact address
account_id	RequiredInteger	Related account ID
status	OptionalString	Active or inactive
assigned_to	OptionalInteger	User ID to assign contact

Example

curl --request PUT \
--url 'https://leads.qreq.com/api/contacts/{contact_id}' \
--header 'X-API-KEY: {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "Jane Doe Updated", "email": "[email protected]", "phone": "1112223333", "position": "Senior Sales Lead", "address": "456 New St", "account_id": 1, "status": "active", "assigned_to": 2 }'

Response example

{ "status": true, "message": "Contact updated successfully.", "data": { "id": 1, "name": "Imran Khan", "email": "[email protected]", "phone": "+1-202-555-0183", "position": "Software Engineer", "address": "123 Main Street, New York, NY 10001", "status": "active", "account_id": 2, "created_by": 33, "assigned_to": 51, "created_at": "2025-11-03T10:53:20.000000Z", "updated_at": "2025-11-03T10:55:07.000000Z" } }

Show

Endpoint

GET https://leads.qreq.com/api/contacts/{contact_id}

Example

curl --request GET \
--url 'https://leads.qreq.com/api/contacts/{contact_id}' \
--header 'X-API-KEY: {api_key}'

Response example

{ "status": "success", "message": "Contact retrieved successfully.", "data": { ...contact object... }, "meetings": [ ...related meetings/calls... ] }

Delete

Endpoint

DELETE https://leads.qreq.com/api/contacts/{contact_id}

Example

curl --request DELETE \
--url 'https://leads.qreq.com/api/contacts/{contact_id}' \
--header 'X-API-KEY: {api_key}'

Response example

{ "status": true, "message": "Contact deleted successfully." }

Toggle Status

Endpoint

PATCH https://leads.qreq.com/api/contacts/{contact_id}/toggle-status

Example

curl --request PATCH \
--url 'https://leads.qreq.com/api/contacts/{contact_id}/toggle-status' \
--header 'X-API-KEY: {api_key}'

Response example

{ "status": "success", "message": "Contact status updated successfully.", "data": { "id": 1, "name": "Imran Khan", "email": "[email protected]", "phone": "+1-202-555-0183", "position": "Software Engineer", "address": "123 Main Street, New York, NY 10001", "status": "inactive", "account_id": 2, "created_by": 33, "assigned_to": 51, "created_at": "2025-11-03T10:53:20.000000Z", "updated_at": "2025-11-03T10:59:27.000000Z" } }