FitnessForce - UFP
Home
Home
  1. Client
  • Introduction
  • Quickstart
  • Webhooks
  • Campaign
    • Get campaign
      GET
    • List campaign
      GET
    • Get campaign by GUID
      GET
    • Get automation by franchise
      GET
    • Get automation by tenant
      GET
    • Get automation by company
      GET
    • Update automation active
      POST
    • Update automation inactive
      POST
    • Update campaign active
      POST
    • Update campaign inactive
      POST
  • Class
    • Get class by id
    • Delete class
    • Update class
    • List classes
    • Create class
    • Substitute coach in class
    • Reschedule class
    • Cancel class
    • Mark class as completed
    • List class bookings by client id
  • Client
    • Retrieves all client for a Tenant
      GET
    • Creates a new client
      POST
    • Gets client by ID
      GET
    • Gets clients birthday list
      GET
    • Gets clients at risk
      GET
    • Gets client mandatory fields
      GET
    • Adds client to blacklist
      POST
    • Removes client from blacklist
      POST
    • Updates client details
      PUT
    • Used for partial updates of client details
      PATCH
    • Changes client representative
      POST
    • Lists prospects
      GET
    • Lists ex-clients
      GET
    • Resets client password
      POST
    • Changes client representative for multiple clients
      POST
    • Lists prospect effective date history
      GET
    • Transfers prospect
      POST
  • Company
    • Get company details
  • Invoice
    • Get invoice PDF
  • Organisation
    • List organisations
    • Get organisation
  • Search
    • Perform Client Search
    • Search clients by tenant
    • Search clients by provider
    • Search clients by company
  • Tax
    • Get Tax Groups
    • Get Tax Group by ID
    • Get Tax Groups by Tenant IDs
    • Get Tax Line Items
    • Get Tax Line Item by ID
    • List Tax Line Items
    • List Tax Line Types
  • Tenant
    • Get tenant details
    • List tenants
    • Gets list of tenants
    • Updates tenant details
    • Gets tenant details
    • Updates tenant invoice template type
    • Updates tenant payment template type
  • 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
    • Get appointment types list
    • Get appointment type details
  • Authentication
    • Refresh Token exchange
    • Generate authentication token
  • Automation
    • Get automation master
    • List automation types
  • Call Transactions
    • Get call transaction details
    • Log new call transaction
    • Update call transaction
    • Delete call transaction
  • Charge Categories
    • List charge categories
    • Get charge category
  • Charge Master
    • List charge masters
    • Get charge master
    • Calculate charge breakup
  • Recurring Class
    • Create recurring class
    • List recurring class template
    • Update recurring class
    • Get recurring class template
    • Cancel recurring class
    • Reschedule recurring class
    • Substitute coach in recurring class
    • List classes by recurring class template ID
  • Class Booking
    • Books client to class
    • Changes client membership
    • Removes client from class
    • Marks client as no-show
    • Marks client as checked in
    • Adds a trial client to class
  • Class Complimentory
    • Creates complimentary class
  • Class Types
    • List class types
    • Get class type details
  • Company level class types
    • List class types
  • Client Communication
    • Gets email log
    • Gets client interactions
    • Lists unified communication messages
  • Client Tasks
    • Gets client tasks
  • Client Sales
    • Gets client sales returns
    • Gets client payments
    • Lists client refunds
  • Client Waivers
    • Gets client waivers
  • Client Sessions
    • Gets client session inventory
  • Client Referrals
    • Lists client referrals
  • Client Offers
    • Lists eligible client coupons
  • Client Export
    • Exports prospects list
    • Exports ex-clients list
    • Exports active clients list
    • Exports clients at risk list
  • Client Billing
    • Creates charges for a client
    • Creates balance payment for invoice
  • Client Check-in
    • Creates client check-in
    • Lists client check-ins
    • Lists client check-ins by tenant
    • Lists clients who are currently in the club
    • Deletes a client check-in
  • Client Credit Balance
    • Creates a new credit balance order for a client
    • Retrieves the credit balance for a client
    • Retrieves the credit balance for a client
    • Lists client credit balance centerwise
  • Client Documents
    • Uploads client document
    • Gets client document
    • Lists client documents
    • Deletes client document
  • Client Invoices
    • Get invoice by UUID
    • Generate balance UUID for invoice
  • Client Membership
    • Change client membership start date
    • Patch client membership
    • Change client membership end date
    • Get client membership details
  • Client Open API
    • Create prospect
    • Book tour
  • Client Payments
    • Get payment timeline
    • List client payment methods
  • Client Subscriptions
    • List client subscription invoices
    • Get client subscription
    • List client subscriptions
    • Get clients by plan ID
    • Change subscription start date
    • Change subscription end date
    • Void client subscription
    • Send manage subscription link
    • Get client subscription by UUID
    • Get client subscription invoices by UUID
  • Client Memberships
    • Change session owner
    • Get session owners
    • List active client memberships
  • Client Subscription Cancellation
    • Cancel client subscription
    • Reactivate client subscription
  • Client Subscription Freeze
    • Create subscription freeze
    • List subscription freezes
    • Stop subscription freeze
    • Cancel subscription freeze
    • List client freezes
    • Get subscriptions available for freeze
    • Update subscription freeze
    • Get subscription freeze timeline
  • Client Trials
    • List client trials
    • Create client trial
    • Get client trial
    • Update trial
    • Delete client trial
    • Activate client trial
    • Mark trial as inactive
    • Mark trial as active
    • List client trials by tenant
    • Export client trials by tenant
  • Client Upgrade
    • Calculates subscription upgrade
    • Voids subscription upgrade
  • Balance Write Off
    • Creates a write off
    • Gets the list of write offs
    • Voids a write off
  • Email Template
    • Create email template
    • List email templates
    • Update email template
    • Get email template
    • Delete email template
    • Mark email template as inactive
    • Mark email template as active
  • 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
    • Create email template at tenant level
    • List email templates at tenant level
    • Update email template at tenant level
    • Get email template at tenant level
    • Delete email template at tenant level
    • Mark email template as inactive at tenant level
    • Mark email template as active at tenant level
  • Franchise Groups
    • Get franchise group details
    • List all franchise groups
  • Payment Methods
    • Initiate payment method update by UUID
    • Initiate payment method update by ID
  • Invoices
    • Get invoice
    • List client invoices
    • Void invoice
    • Get invoice PDF
    • Send invoice PDF
    • List invoice details
    • Change invoice sales rep
    • Send invoice clear balance link
  • Offer Master
    • List offer master
    • Get offer master
    • List eligible coupon master
    • List offer master coupon code link
    • List offer master service plan product link
    • List offer master organisation link
  • Online Signup
    • Get subscription plans
    • Get mandatory client fields
    • Get subscription plan details
    • Create client and invoice
  • Subscription
    • Get eligible add-ons
  • Sales
    • Get sales return PDF
  • 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
    • List opportunities
    • Create opportunity
    • Get opportunity
    • Update opportunity
    • Delete opportunity
    • Change opportunity stage
    • Mark opportunity as won
    • Mark opportunity as lost
    • Mark opportunity as nurture
    • Update opportunity sort order
  • Opportunity Stage Master
    • List opportunity stage masters
    • Get opportunity stage master
  • Payments
    • Get payment details
    • Mark payment as void
    • Get payment PDF
    • Send payment PDF
  • Refunds
    • List refunds
    • Send refund PDF
    • Get refund PDF
  • Reports
    • Reporting Quickstart
    • GET Report Data
  • Report Filter Schedules
    • Create report filter schedule
    • Delete report filter schedule
  • Access Requests
    • Request access via email
  • Rooms
    • List rooms
    • Get room details
  • Sales Returns
    • Get sales return PDF
  • Email Communication
    • Send free form email
  • SMS
    • Send free form SMS
  • Service Categories
    • List service categories
    • Get service category
    • Get service category collections
  • Staff Management
    • Get staff by ID
    • List all staff
    • List staff schedules
    • List staff appointment types
  • Staff Appointment Type Link
    • Gets staff appointment type links
  • Staff Notifications
    • Mark staff notifications as read
    • Mark staff notification as deleted
    • List staff notifications
  • Staff Schedule
    • Lists staff schedules
    • Gets staff schedule
  • Subscription Plans
    • List subscription plans
    • Get subscription plan by ID
    • Get eligible addons
  • Subscription Signup
    • Get Order Summary
    • Validate Referral
    • Get Order Summary Billing Occurrence
    • Get Order Status
    • Get Waivers
    • Get Payment Methods
    • List Empty Client Mandatory Fields
    • Sign Guest Waiver
    • Send Payment Link
    • Send Signup Completion Link
  • Tasks
    • Create task for client
    • Create task for opportunity
    • List tasks
    • Get task details
    • Complete SMS task
    • Bulk reassign tasks
  • Task Categories
    • List task categories
    • Get task category
  • Task Open API
    • Reschedule tour
    • Get tour details
  • Trial Master
    • List trials
    • Get trial
  1. Client

Retrieves all client for a Tenant

GET
/tenants/{tenant_id}/clients
Client
Gets a list of clients based on the provided filter criteria

Request

Path Params
tenant_id
integer <int32>
required
ID of the tenant
Query Params
client_id
array[integer <int64>]
optional
IDs of the clients to filter by
client_status
array[string]
optional
Client statuses to filter by
Allowed values:
ProspectTrialClientClientNonMemberExClientBlockedClientExClientNonMember
client_representative_id
array[integer <int32>]
optional
IDs of client representatives to filter by
source
string 
optional
Source to filter by
channel
string 
optional
Channel to filter by
opp_stage_master_id
array[integer <int32>]
optional
Opportunity stage master IDs to filter by
PageNumber
integer <int32>
optional
PageSize
integer <int32>
optional

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 GET '/tenants//clients'

Responses

🟢200OK
text/plain
OK
Body
items
array[object (ListClientResponse) {38}]  | null 
optional
id
integer <int64>
optional
company_id
integer <int32>
optional
client_status
enum<string> 
optional
Available values:
Prospect -
Trial -
Client -
ClientNonMember -
ExClient -
BlockedClient -
ExClientNonMember -
Allowed values:
ProspectTrialClientClientNonMemberExClientBlockedClientExClientNonMember
is_mobile_verified
boolean 
optional
is_email_verified
boolean 
optional
image
string  | null 
optional
home_club_tenant_id
integer <int32>
optional
is_waiver
boolean 
optional
is_blacklisted
boolean 
optional
online_booking_stopped_until
string <date-time>
optional
created_date
string <date-time>
optional
updated_by
integer <int32>
optional
updated_date
string <date-time>
optional
full_name
string  | null 
optional
mobile_number
integer <int64>
optional
mobile_country_code
string  | null 
optional
email_id
string  | null 
optional
date_of_birth
string <date> | null 
optional
gender
enum<string> 
optional
Available values:
Female -
Male -
Transgender -
NonBinaryOrNonConforming -
PreferNotToRespond -
Allowed values:
FemaleMaleTransgenderNonBinaryOrNonConformingPreferNotToRespond
address
string  | null 
optional
pincode
string  | null 
optional
location
string  | null 
optional
client_representative_id
integer <int32>
optional
createdin_tenant_id
integer <int32>
optional
source
string  | null 
optional
channel
string  | null 
optional
total_outstanding_in_minor_currency
integer <int64>
optional
client_since
string <date-time>
optional
application_installed
boolean 
optional
board_type
enum<string> 
optional
Available values:
NewMemberBoard -
ExistingMemberBoard -
Allowed values:
NewMemberBoardExistingMemberBoard
stage_master_id
integer <int32>
optional
prospect_effective_date
string <date-time> | null 
optional
churn_date
string <date-time> | null 
optional
referral_code
string  | null 
optional
is_child
boolean 
optional
parent_client_id
integer <int64>
optional
relation
enum<string> 
optional
Available values:
None -
Parent -
Child -
Spouse -
Sibling -
Friend -
Partner -
Colleague -
Other -
Allowed values:
NoneParentChildSpouseSiblingFriendPartnerColleagueOther
latest_createdin_tenant_id
integer <int32>
optional
statistics
array[object (ListClientResponse) {38}]  | null 
optional
id
integer <int64>
optional
company_id
integer <int32>
optional
client_status
enum<string> 
optional
Available values:
Prospect -
Trial -
Client -
ClientNonMember -
ExClient -
BlockedClient -
ExClientNonMember -
Allowed values:
ProspectTrialClientClientNonMemberExClientBlockedClientExClientNonMember
is_mobile_verified
boolean 
optional
is_email_verified
boolean 
optional
image
string  | null 
optional
home_club_tenant_id
integer <int32>
optional
is_waiver
boolean 
optional
is_blacklisted
boolean 
optional
online_booking_stopped_until
string <date-time>
optional
created_date
string <date-time>
optional
updated_by
integer <int32>
optional
updated_date
string <date-time>
optional
full_name
string  | null 
optional
mobile_number
integer <int64>
optional
mobile_country_code
string  | null 
optional
email_id
string  | null 
optional
date_of_birth
string <date> | null 
optional
gender
enum<string> 
optional
Available values:
Female -
Male -
Transgender -
NonBinaryOrNonConforming -
PreferNotToRespond -
Allowed values:
FemaleMaleTransgenderNonBinaryOrNonConformingPreferNotToRespond
address
string  | null 
optional
pincode
string  | null 
optional
location
string  | null 
optional
client_representative_id
integer <int32>
optional
createdin_tenant_id
integer <int32>
optional
source
string  | null 
optional
channel
string  | null 
optional
total_outstanding_in_minor_currency
integer <int64>
optional
client_since
string <date-time>
optional
application_installed
boolean 
optional
board_type
enum<string> 
optional
Available values:
NewMemberBoard -
ExistingMemberBoard -
Allowed values:
NewMemberBoardExistingMemberBoard
stage_master_id
integer <int32>
optional
prospect_effective_date
string <date-time> | null 
optional
churn_date
string <date-time> | null 
optional
referral_code
string  | null 
optional
is_child
boolean 
optional
parent_client_id
integer <int64>
optional
relation
enum<string> 
optional
Available values:
None -
Parent -
Child -
Spouse -
Sibling -
Friend -
Partner -
Colleague -
Other -
Allowed values:
NoneParentChildSpouseSiblingFriendPartnerColleagueOther
latest_createdin_tenant_id
integer <int32>
optional
total_items
integer <int64>
optional
total_pages
integer <int64>
optional
current_page
integer <int64>
optional
Example
{
    "items": [
        {
            "id": 0,
            "company_id": 0,
            "client_status": "Prospect",
            "is_mobile_verified": true,
            "is_email_verified": true,
            "image": "string",
            "home_club_tenant_id": 0,
            "is_waiver": true,
            "is_blacklisted": true,
            "online_booking_stopped_until": "2019-08-24T14:15:22Z",
            "created_date": "2019-08-24T14:15:22Z",
            "updated_by": 0,
            "updated_date": "2019-08-24T14:15:22Z",
            "full_name": "string",
            "mobile_number": 0,
            "mobile_country_code": "string",
            "email_id": "string",
            "date_of_birth": "2019-08-24",
            "gender": "Female",
            "address": "string",
            "pincode": "string",
            "location": "string",
            "client_representative_id": 0,
            "createdin_tenant_id": 0,
            "source": "string",
            "channel": "string",
            "total_outstanding_in_minor_currency": 0,
            "client_since": "2019-08-24T14:15:22Z",
            "application_installed": true,
            "board_type": "NewMemberBoard",
            "stage_master_id": 0,
            "prospect_effective_date": "2019-08-24T14:15:22Z",
            "churn_date": "2019-08-24T14:15:22Z",
            "referral_code": "string",
            "is_child": true,
            "parent_client_id": 0,
            "relation": "None",
            "latest_createdin_tenant_id": 0
        }
    ],
    "statistics": [
        {
            "id": 0,
            "company_id": 0,
            "client_status": "Prospect",
            "is_mobile_verified": true,
            "is_email_verified": true,
            "image": "string",
            "home_club_tenant_id": 0,
            "is_waiver": true,
            "is_blacklisted": true,
            "online_booking_stopped_until": "2019-08-24T14:15:22Z",
            "created_date": "2019-08-24T14:15:22Z",
            "updated_by": 0,
            "updated_date": "2019-08-24T14:15:22Z",
            "full_name": "string",
            "mobile_number": 0,
            "mobile_country_code": "string",
            "email_id": "string",
            "date_of_birth": "2019-08-24",
            "gender": "Female",
            "address": "string",
            "pincode": "string",
            "location": "string",
            "client_representative_id": 0,
            "createdin_tenant_id": 0,
            "source": "string",
            "channel": "string",
            "total_outstanding_in_minor_currency": 0,
            "client_since": "2019-08-24T14:15:22Z",
            "application_installed": true,
            "board_type": "NewMemberBoard",
            "stage_master_id": 0,
            "prospect_effective_date": "2019-08-24T14:15:22Z",
            "churn_date": "2019-08-24T14:15:22Z",
            "referral_code": "string",
            "is_child": true,
            "parent_client_id": 0,
            "relation": "None",
            "latest_createdin_tenant_id": 0
        }
    ],
    "total_items": 0,
    "total_pages": 0,
    "current_page": 0
}
Modified at 2025-03-21 07:23:14
Previous
List class bookings by client id
Next
Creates a new client
Built with