Show
Prod Env
{{subdomain}}/api2
Prod Env
{{subdomain}}/api2
GET
{{subdomain}}/api2
Last modified:2025-04-12 17:56:37
Maintainer:Not configured
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{subdomain}}/api2/clients/{{clientId}}' \
--header 'APIKEY: {{APIKEY}}'
Response Response Example
{
"result": "successful",
"code": 200,
"data": {
"Client": {
"id": "107",
"is_offline": "1",
"client_number": "104",
"site_id": "2892083",
"staff_id": "-3",
"business_name": "Mock Business",
"first_name": "John",
"last_name": "Doe",
"email": "mock@example.com",
"address1": "123 Mock Street",
"address2": "Apt 456",
"city": "Mock City",
"state": "Mock State",
"postal_code": "12345",
"phone1": "123-456-7890",
"phone2": "098-765-4321",
"country_code": "US",
"notes": "These are mock notes.",
"active_secondary_address": "1",
"secondary_name": "Jane Doe",
"secondary_address1": "456 Secondary St",
"secondary_address2": "Suite 789",
"secondary_city": "Secondary City",
"secondary_state": "Secondary State",
"secondary_postal_code": "67890",
"secondary_country_code": "US",
"language_code": null,
"default_currency_code": "USD",
"last_login": null,
"suspend": "0",
"last_ip": null,
"created": "2024-06-10 10:13:37",
"modified": "2024-06-10 10:13:37",
"follow_up_status": null,
"category": "Mock Category",
"original_site_id": null,
"group_price_id": "2",
"timezone": "-5",
"bn1": "Business Note 1",
"bn1_label": "Label 1",
"bn2_label": "Label 2",
"bn2": "Business Note 2",
"starting_balance": "1000",
"photo": null,
"birth_date": "1990-01-01",
"gender": "1",
"map_location": "40.712776,-74.005974,5",
"type": "3",
"credit_limit": "5000",
"credit_period": "30",
"national_id": null,
"branch_id": "1",
"category_id": "10",
"link": null,
"secondary_follow_up_status": null,
"CustomModel": {
"id": null,
"client_id": null,
"created": null,
"modified": null,
"staff_id": null,
"field_2": null,
"field_3": null,
"field_4": null,
"field_5": null,
"field_7": null,
"field_8": null,
"field_9": null,
"field_10": null,
"field_11": null,
"field_27": null
}
}
}
}
Request
Header Params
APIKEY
stringÂ
required
Example:
{{APIKEY}}