List all Clients

GET/api/clients

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
clientid Number Mandatory Clientid unique ID
curl -X GET "https://yoursite.com/api/clients" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

{
		"id": "2",
		"company_name": "jdoe",
		"address": "Rajkot",
		"city": "",
		"state": "",
		"zip": "",
		"country": "",
		"created_date": "2021-09-12",
		"website": "",
		"phone": "",
		"currency_symbol": "INR",
		"starred_by": "",
		"group_ids": "1",
		"deleted": "0",
		"is_lead": "0",
		"lead_status_id": "1",
		"owner_id": "1",
		"created_by": "1",
		"sort": "0",
		"lead_source_id": "1",
		"last_lead_status": "New",
		"client_migration_date": "2021-09-12",
		"vat_number": "",
		"currency": "USD",
		"disable_online_payment": "1",
		"primary_contact": "john doe",
		"primary_contact_id": "4",
		"contact_avatar": null,
		"total_projects": "7",
		"payment_received": "0",
		"invoice_value": "1188",
		"client_groups": "Test c group ",
		"lead_status_title": "New",
		"lead_status_color": "#f1c40f",
		"owner_name": "john doe",
		"owner_avatar": null
}
MethodGET
Path/api/clients
GroupClients
Sincev1.0.0
Defined inRestApi/Controllers/ClientsController.php