Gives you a list of your clients
/clients
https://api.oauth.pabau.com/{api_key}/clients
Request
| Query Parameters: | |
| api_key * | |
| per_page | (int) If not sent, the default is 20. Maximum 50 |
| page | (int) If not sent, the first 20 will be returned |
Response sample
application/json
{
"success": true,
"total": 1,
"clients": [
{
"details": {
"id": 12345678,
"custom_id": "1234",
"first_name": "John",
"last_name": "Doe",
"DOB": "1989-09-01",
"gender": "Male",
"avatar": null,
"source": [
],
"last_updated_date": "",
"is_active": 1
},
"communications": {
"email": "john@doe.com",
"phone": "",
"mobile": "123456789",
"opt_in_email": 0,
"opt_in_phone": 1,
"opt_in_post": 1,
"opt_in_sms": 0,
"opt_in_newsletter": 1
},
"address": {
"mailing_street": "some street",
"other_street": "",
"mailing_city": "London",
"mailing_county": "",
"mailing_country": "United Kingdom",
"MailingPostal": ""
},
"created": {
"created_date": "2023-09-04 08:29:51",
"owner": [
{
"created_by_id": 12345,
"full_name": "Jane Doe"
}
]
},
"client_insights": [
{
"id": 8368517,
"sync_id": 75793,
"contact_id": 12345678,
"company_id": 12345,
"last_visit_days": 1,
"last_appt_date": "2024-08-20 10:00:00",
"next_visit_days": 0,
"next_appt_date": null,
"total_appts": 10,
"total_noshow": 0,
"total_cancelled": 0,
"total_completed": 2,
"last_appt_user_id": 12345,
"last_appt_with": "Jane Doe",
"last_appt_service_id": 123456,
"last_appt_service": "botox",
"next_appt_user_id": null,
"next_appt_with": null,
"next_appt_service_id": null,
"next_appt_service": null,
"favorite_user_id": 96787,
"favorite_member": "Jane Doe",
"first_visit": "2024-05-08 10:30:00",
"total_visits": 7,
"appt_frequency": "52.14",
"age_years": "34.00",
"total_spend": "112234.75",
"avg_spend": "503.29",
"review_score": "0.00",
"est_next_appt_date": "2031-08-19 10:00:00",
"service_sales": "0.00",
"retail_sales": "0.00",
"package_sales": "0.00",
"retail_percent": "0.00",
"birth_month": 9,
"total_forms": 1,
"completed_medical_history": null,
"preferred_location_id": null,
"total_photos": 0,
"most_booked_category_id": null,
"total_referred": 0,
"is_online_booking": 1,
"pabau_score": 0,
"ectc": 0,
"ectc_date": null,
"cctt": 0,
"cctt_date": null,
"total_paid": "37057.75",
"account_amount": "22167.46",
"outstanding_amount": "75177.00",
"balance": "-53009.54",
"total_activity": 0,
"last_medical_history_days": 0,
"due_botox_recall": 0,
"due_filler_recall": 0,
"last_feedback_received": null,
"outstanding_invoice_no": "71,72,73,74",
"updated_at": "2024-08-21 05:01:46",
"birth_date": "09-01"
}
],
"custom": [
{
"custom_field_id": 66345,
"custom_field_label": "Treatment Interest",
"custom_field_value": "botox"
},
{
"custom_field_id": 66346,
"custom_field_label": "GP Name",
"custom_field_value": "some name"
},
{
"custom_field_id": 66347,
"custom_field_label": "GP Address",
"custom_field_value": "some address"
},
{
"custom_field_id": 66348,
"custom_field_label": "Next of Kin",
"custom_field_value": ""
},
{
"custom_field_id": 66349,
"custom_field_label": "Next of kin name",
"custom_field_value": ""
},
{
"custom_field_id": 66350,
"custom_field_label": "Next of kin relationship",
"custom_field_value": ""
}
],
"relationships": [
{
"relationship_id": 123456789,
"relationship_name": "father",
"relationship_type": "family"
},
{
"relationship_id": 1234567899,
"relationship_name": null,
"relationship_type": "insurance"
}
],
"insurance": {
"insurer_name": "Name",
"membership_number": "1234561223",
"cases": 0
},
"allergies": [
{
"allergy_name": "Zirtek Allergy",
"date_added": "2024-08-21 08:50:06",
"reaction": "myalgia"
}
],
"appointments": [
{
"appointment_date": "22/08/2024 11:15",
"service": "ertert"
}
]
}
]
}