GET Single Client
Prod Env
{{subdomain}}/api2
Prod Env
{{subdomain}}/api2
GET
{{subdomain}}/api2
Last modified:2025-04-20 12:10:30
Maintainer:Not configured
id: Client ID (required){
"result": "success",
"code": 200,
"data": {
"Client": {
"id": 15,
"type": 2,
"business_name": "ACME Corp",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone1": "555-1234",
"address1": "123 Main St",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_code": "US",
"created": "2023-01-15 10:30:22",
"modified": "2023-03-10 14:25:18",
"balance": 250.00,
"active": 1,
// Additional client fields...
"custom_fields": {
"field1": "value1",
"field2": "value2"
}
},
"Invoices": [
{
"id": 123,
"number": "INV-2023-001",
"date": "2023-03-23",
"due_date": "2023-04-22",
"total": 120.00,
"status": 1
// Additional invoice summary fields...
}
// Other recent invoices...
]
}
}Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{subdomain}}/api2/api2/clients/{{id}}.json'Response Response Example
200 - Success Response
{
"result": "success",
"code": 200,
"data": {
"Client": {
"id": 15,
"type": 2,
"business_name": "ACME Corp",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone1": "555-1234",
"phone2": "",
"address1": "123 Main St",
"address2": "Suite 300",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_code": "US",
"website": "https://acmecorp.example.com",
"tax_registration": "12-3456789",
"created": "2023-01-15 10:30:22",
"modified": "2023-03-10 14:25:18",
"balance": 250,
"active": 1,
"notes": "Important client - VIP status",
"group_id": 1,
"group_name": "Corporate Clients",
"custom_fields": {
"industry": "Technology",
"referral_source": "Website Contact Form"
}
},
"Invoices": [
{
"id": 123,
"number": "INV-2023-001",
"date": "2023-03-23",
"due_date": "2023-04-22",
"total": 120,
"status": 1
},
{
"id": 118,
"number": "INV-2023-0095",
"date": "2023-02-15",
"due_date": "2023-03-17",
"total": 250,
"status": 2
}
]
}
}Request
None