- Introduction
- Quickstart
- Webhooks
- Campaign
- Class
- Client
- Retrieves all client for a Tenant
- Creates a new client
- Gets client by ID
- Gets clients birthday list
- Gets clients at risk
- Gets client mandatory fields
- Adds client to blacklist
- Removes client from blacklist
- Updates client details
- Used for partial updates of client details
- Changes client representative
- Lists prospects
- Lists ex-clients
- Resets client password
- Changes client representative for multiple clients
- Lists prospect effective date history
- Transfers prospect
- Company
- Invoice
- Organisation
- Search
- Tax
- Tenant
- Appointments
- Create new appointment
- List appointments
- Change client membership in appointment
- Get appointment
- Update appointment
- Mark client as checked in
- Mark client as no-show
- Substitute coach for appointment
- Reschedule appointment
- Cancel appointment
- List appointments by client ID
- Create appointment complimentory session
- Create appointment
- Reschedule appointment
- Get appointment
- Appointment Types
- Authentication
- Automation
- Call Transactions
- Charge Categories
- Charge Master
- Recurring Class
- Class Booking
- Class Complimentory
- Class Types
- Company level class types
- Client Communication
- Client Tasks
- Client Sales
- Client Waivers
- Client Sessions
- Client Referrals
- Client Offers
- Client Export
- Client Billing
- Client Check-in
- Client Credit Balance
- Client Documents
- Client Invoices
- Client Membership
- Client Open API
- Client Payments
- Client Subscriptions
- Client Memberships
- Client Subscription Cancellation
- Client Subscription Freeze
- Client Trials
- Client Upgrade
- Balance Write Off
- Email Template
- Email Template - Franchise
- Create email template at franchise level
- Get list of email templates at franchise level
- Update email template at franchise level
- Get email template at franchise level
- Delete email template at franchise level
- Mark email template as inactive at franchise level
- Mark email template as active at franchise level
- Email Template - Tenant
- Franchise Groups
- Payment Methods
- Invoices
- Offer Master
- Online Signup
- Subscription
- Sales
- Staff Availability
- List staff availability
- List staff availability by appointment category
- List next available slots by appointment category
- Check staff availability
- Check staff availability for appointment category
- Check staff availability for recurring schedule
- Check staff availability for recurring schedule
- Get staff scheduled unavailability
- List staff availability for tours
- Opportunities
- Opportunity Stage Master
- Payments
- Refunds
- Reports
- Report Filter Schedules
- Access Requests
- Rooms
- Sales Returns
- Email Communication
- SMS
- Service Categories
- Staff Management
- Staff Appointment Type Link
- Staff Notifications
- Staff Schedule
- Subscription Plans
- Subscription Signup
- Tasks
- Task Categories
- Task Open API
- Trial Master
Perform Client Search
POST
/search
Search
Request
Body Params application/json
language
string  | nullÂ
optional
query
string  | nullÂ
optional
providers
array[object (Providers) {2}]  | nullÂ
optional
provider_name
enum<string>Â
optional
Clients -Actions -KbDocuments -ProspectsAndTrials -ActiveClientsAndNonMembers -ExClientsAndNonMembers -BlockedClients -Allowed values:
ClientsActionsKbDocumentsProspectsAndTrialsActiveClientsAndNonMembersExClientsAndNonMembersBlockedClients
pagination
object (PaginationFilter)Â
optional
Example
{
"language": "string",
"query": "string",
"providers": [
{
"provider_name": "Clients",
"pagination": {
"page_number": 0,
"page_size": 0
}
}
]
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/search' \
--header 'Content-Type: application/json' \
--data-raw '{
"language": "string",
"query": "string",
"providers": [
{
"provider_name": "Clients",
"pagination": {
"page_number": 0,
"page_size": 0
}
}
]
}'Responses
🟢200OK
text/plain
Body
originalQuery
string  | nullÂ
optional
autocompleteSuggestion
string  | nullÂ
optional
language
string  | nullÂ
optional
baseurl
string  | nullÂ
optional
searchResults
object (SearchResults)Â
optional
clients
object (ElasticSearchClientsResponsePagedResults)Â
optional
invoices
object (InvoicesResponsePagedResults)Â
optional
actions
object (ActionResponsePagedResults)Â
optional
kbdocs
object (KbdocsResponsePagedResults)Â
optional
company
object (ElasticSearchCompanyResponsePagedResults)Â
optional
client_communications
object (UnifiedCommunicationMessagePagedResults)Â
optional
Example
{
"originalQuery": "string",
"autocompleteSuggestion": "string",
"language": "string",
"baseurl": "string",
"searchResults": {
"clients": {
"items": [
{
"clt_id": 0,
"clt_createdin_tenant_id": 0,
"clt_latest_createdin_tenant_id": 0,
"clt_company_id": 0,
"clt_full_name": "string",
"clt_gender": "Female",
"clt_dateofbirth": 0,
"clt_emailid": "string",
"clt_image": "string",
"clt_mobile_no": 0,
"clt_mobile_country_code": "string",
"clt_status": "Prospect",
"clt_sub_status": "FutureClient",
"clt_second_mobile_no": 0,
"clt_second_mobile_country_code": "string",
"clt_addr": "string",
"clt_location": "string",
"clt_country_code": "string",
"clt_state_code": "string",
"clt_city_code": "string",
"clt_addr_pincode": 0,
"clt_place_id": "string",
"clt_placeid_request": "string",
"clt_preferred_language": "string",
"clt_emergency_contact_no": "string",
"clt_emergency_contact_person": "string",
"clt_medical_alert": "string",
"clt_note": "string",
"clt_outstanding_due": 0,
"clt_source": "string",
"clt_channel": "string",
"clt_referred_by": 0,
"clt_heartrate_monitoring_id": "string",
"clt_dropout_score": 0,
"clt_lifetime_value_in_minor_curr": 0,
"clt_taxnumber": "string",
"clt_bulk_insert_guid": "string",
"clt_rep_id": 0,
"clt_home_club_tenant_id": 0,
"clt_latest_waiver_date": 0,
"clt_latest_waiver_path": "string",
"clt_checkin_status": true,
"clt_last_visited_date": 0,
"clt_last_visited_centre": 0,
"clt_is_erroneous": true,
"clt_is_mobile_verified": true,
"clt_is_email_verified": true,
"clt_is_blacklisted": true,
"clt_blacklisted_reason": "string",
"clt_is_waiver": true,
"clt_promotional_sms": true,
"clt_promotional_email": true,
"clt_promotional_phone": true,
"clt_migration_id": "string",
"clt_custom_fields": "string",
"clt_current_keyfob": "string",
"clt_at_risk": true,
"clt_created_by": 0,
"clt_updated_by": 0,
"clt_created_date": 0,
"clt_updated_date": 0,
"clt_track_mode": "StaffWebApp",
"clt_online_booking_stopped_until": 0,
"clt_total_outstanding_in_minor_curr": 0,
"clt_since": 0,
"clt_app_installed": true
}
],
"statistics": [
{
"clt_id": 0,
"clt_createdin_tenant_id": 0,
"clt_latest_createdin_tenant_id": 0,
"clt_company_id": 0,
"clt_full_name": "string",
"clt_gender": "Female",
"clt_dateofbirth": 0,
"clt_emailid": "string",
"clt_image": "string",
"clt_mobile_no": 0,
"clt_mobile_country_code": "string",
"clt_status": "Prospect",
"clt_sub_status": "FutureClient",
"clt_second_mobile_no": 0,
"clt_second_mobile_country_code": "string",
"clt_addr": "string",
"clt_location": "string",
"clt_country_code": "string",
"clt_state_code": "string",
"clt_city_code": "string",
"clt_addr_pincode": 0,
"clt_place_id": "string",
"clt_placeid_request": "string",
"clt_preferred_language": "string",
"clt_emergency_contact_no": "string",
"clt_emergency_contact_person": "string",
"clt_medical_alert": "string",
"clt_note": "string",
"clt_outstanding_due": 0,
"clt_source": "string",
"clt_channel": "string",
"clt_referred_by": 0,
"clt_heartrate_monitoring_id": "string",
"clt_dropout_score": 0,
"clt_lifetime_value_in_minor_curr": 0,
"clt_taxnumber": "string",
"clt_bulk_insert_guid": "string",
"clt_rep_id": 0,
"clt_home_club_tenant_id": 0,
"clt_latest_waiver_date": 0,
"clt_latest_waiver_path": "string",
"clt_checkin_status": true,
"clt_last_visited_date": 0,
"clt_last_visited_centre": 0,
"clt_is_erroneous": true,
"clt_is_mobile_verified": true,
"clt_is_email_verified": true,
"clt_is_blacklisted": true,
"clt_blacklisted_reason": "string",
"clt_is_waiver": true,
"clt_promotional_sms": true,
"clt_promotional_email": true,
"clt_promotional_phone": true,
"clt_migration_id": "string",
"clt_custom_fields": "string",
"clt_current_keyfob": "string",
"clt_at_risk": true,
"clt_created_by": 0,
"clt_updated_by": 0,
"clt_created_date": 0,
"clt_updated_date": 0,
"clt_track_mode": "StaffWebApp",
"clt_online_booking_stopped_until": 0,
"clt_total_outstanding_in_minor_curr": 0,
"clt_since": 0,
"clt_app_installed": true
}
],
"total_items": 0,
"total_pages": 0,
"current_page": 0
},
"invoices": {
"items": [
{
"tenantid": 0,
"companyid": 0,
"invoiceid": "string",
"clientid": "string",
"purchasedate": "2019-08-24T14:15:22Z",
"invoiceamt": 0,
"balanceamt": 0
}
],
"statistics": [
{
"tenantid": 0,
"companyid": 0,
"invoiceid": "string",
"clientid": "string",
"purchasedate": "2019-08-24T14:15:22Z",
"invoiceamt": 0,
"balanceamt": 0
}
],
"total_items": 0,
"total_pages": 0,
"current_page": 0
},
"actions": {
"items": [
{
"action": "string",
"action_url": "string",
"action_desc": "string"
}
],
"statistics": [
{
"action": "string",
"action_url": "string",
"action_desc": "string"
}
],
"total_items": 0,
"total_pages": 0,
"current_page": 0
},
"kbdocs": {
"items": [
{
"url": "string",
"title": "string",
"subtitle": "string",
"description": "string"
}
],
"statistics": [
{
"url": "string",
"title": "string",
"subtitle": "string",
"description": "string"
}
],
"total_items": 0,
"total_pages": 0,
"current_page": 0
},
"company": {
"items": [
{
"id": 0,
"uuid": "string",
"status": "InActive",
"name_pri_langs": "string",
"name_sec_lang": "string",
"subdomain": "string",
"purchase_portal_enable": true,
"member_portal_enable": true,
"pri_lang": "string",
"is_sec_lang": true,
"sec_lang": "string",
"email_id": "string",
"website": "string",
"phone1": "string",
"phone2": "string",
"address1": "string",
"address2": "string",
"about_us_pri_lang": "string",
"about_us_sec_lang": "string",
"is_privacy_policy_url": true,
"is_terms_of_service_url": true,
"privacy_policy": "string",
"terms_of_service": "string",
"privacy_policy_url": "string",
"terms_of_service_url": "string",
"account_manager_id": 0,
"imglogo": "string"
}
],
"statistics": [
{
"id": 0,
"uuid": "string",
"status": "InActive",
"name_pri_langs": "string",
"name_sec_lang": "string",
"subdomain": "string",
"purchase_portal_enable": true,
"member_portal_enable": true,
"pri_lang": "string",
"is_sec_lang": true,
"sec_lang": "string",
"email_id": "string",
"website": "string",
"phone1": "string",
"phone2": "string",
"address1": "string",
"address2": "string",
"about_us_pri_lang": "string",
"about_us_sec_lang": "string",
"is_privacy_policy_url": true,
"is_terms_of_service_url": true,
"privacy_policy": "string",
"terms_of_service": "string",
"privacy_policy_url": "string",
"terms_of_service_url": "string",
"account_manager_id": 0,
"imglogo": "string"
}
],
"total_items": 0,
"total_pages": 0,
"current_page": 0
},
"client_communications": {
"items": [
{
"company_id": 0,
"tenant_id": 0,
"client_id": 0,
"staff_id": 0,
"thread_id": "string",
"message_id": "string",
"reply_id": "string",
"communication_type": "None",
"direction": "Incoming",
"from": "string",
"to": "string",
"cc": "string",
"bcc": "string",
"subject": "string",
"message": "string",
"track_mode": "StaffWebApp",
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"conversation_date": "2019-08-24T14:15:22Z"
}
],
"statistics": [
{
"company_id": 0,
"tenant_id": 0,
"client_id": 0,
"staff_id": 0,
"thread_id": "string",
"message_id": "string",
"reply_id": "string",
"communication_type": "None",
"direction": "Incoming",
"from": "string",
"to": "string",
"cc": "string",
"bcc": "string",
"subject": "string",
"message": "string",
"track_mode": "StaffWebApp",
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"conversation_date": "2019-08-24T14:15:22Z"
}
],
"total_items": 0,
"total_pages": 0,
"current_page": 0
}
}
}🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
Modified at 2025-03-21 07:23:14