Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Client

Get Client

Get a Client record by ID.

get/clients/{client_id}

Path parameters

client_idinteger required

Client Id

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Response

Client Data

idinteger

ClientId

first_namestring

Client's First Name

last_namestring

Client's Last Name

emailstring

Clien'ts Email Address

phone_numberstring

Client's Phone Number

billing_cc_emailstring

Client's Billing CC Email

client_status_idinteger

Client's Status Id

client_statusstring

Client's Status

location_idinteger

Client's Location Id

locationstring

Client's Location

default_program_idinteger

Client's Default Gym Program Id

default_programstring

Client's Default Gym Program

date_of_birthstring date

Client's Date of Birth

gender_idinteger

Client's Gender Id

genderstring

Client's Gender

street_address_1string

Client's Street Address 1

street_address_2string

Client's Street Address 2

citystring

Client's City

state_idinteger

Client's State Id

statestring

Client's State

provincestring

Client's Province

zipcodestring

Client's Zipcode

country_idinteger

Client's Country Id

countrystring

Client's Country

timezone_idinteger

Client's TimeZone Id

timezonestring

Client's TimeZone

height_measurement_1integer

The 1st component of the user's height measurement. (Feet or meters depending on the UOM chosen).

height1_system_of_measurestring

System of Measure for Height 1

height_measurement_2integer

The 2nd component of the user's height measurement. (Inches or centimeters depending on the UOM chosen).

height2_system_of_measurestring

System of Measure for Height 2

weightnumber

Client's Weight

weight_system_of_measurestring

Customer's system of measurement for weight and height.

is_email_subscribedboolean

Determines if the Client is subscribed to receive emails

is_sms_subscribedboolean

Determines if the Client is subscribed to receive SMS

tagsstring[]

Client's Tags

notesstring

Client's Notes

emergency_contact_namestring

Client's Emergency Contact

emergency_contact_phonestring

Client's Emergency Contact Phonne Number

has_overdue_invoicesboolean

Indicates if the Client has unpaid invoices

has_membershipboolean

Indicates if the Client has any active Memberships

has_payment_methodboolean

Indicates if a Client has a Payment Method on file

has_store_creditboolean

Determines if the Client has store credit

last_attendancestring date-time

Datetime that the Clien't last attended a class/session/appointment.

days_since_last_attendedinteger

Number of days since the Client last attended

member_sincestring date

The Date the Client has been a member since

last_contactedstring date

Date the Client was last contacted

is_at_riskboolean
retain_snooze_until_datestring date

Retain Snooze Until Date

is_initial_email_sentboolean

Indicates if the Initial Welcome Email has been sent to the Client

lead_idinteger

Id of the Lead that Client was converted from

lead_source_idinteger

The Id of the Lead Source if the Client was converted from a Lead

lead_sourcestring

The Lead Source if the Client was converted from a Lead

referring_user_idinteger

The Id of the User that referred the Lead, if the Client was converted from a Lead

referring_userstring

The Name of the User that referred the Lead, if the Client was converted from a Lead

is_converted_from_leadboolean

Indicates if the Client was converted from a Lead

member_deactivation_reasonstring

The reason why the Client was deactivated

client_owner_idinteger

user id of client owner

client_ownerstring

name of client owner

total_class_sign_insinteger

Total number of Classes the Client has signed into.

total_booking_sign_insinteger

Total number of Appointment Bookings the Client has signed into.

last_class_sign_instring date-time

Date and time of the last Class the Client has signed into.

last_booking_sign_instring date-time

Date and time of the last Appointment Booking the Client has signed into.

current_weekstreakinteger

Clients Current weekstreak

highest_weekstreakinteger

Clients Highest weekstreak

current_weekstreak_updatedonstring date-time

The last time the user had their weekstreak updated on.

coach_titlestring

coach title

coach_biostring

coach biography html

is_display_coach_on_mobile_appboolean

Is Display On Mobile App

coach_link_1_iconstring

coach link 1 icon

coach_link_1_urlstring

coach link 1 url

coach_link_2_iconstring

coach link 2 icon

coach_link_2_urlstring

coach link 2 url

coach_link_3_iconstring

coach link 3 icon

coach_link_3_urlstring

coach link 3 url

coach_link_4_iconstring

coach link 4 icon

coach_link_4_urlstring

coach link 4 url

coach_link_5_iconstring

coach link 5 icon

coach_link_5_urlstring

coach link 5 url

next_class_reservationstring date-time

Date and time of next (soonest in the future) Reservation in the Status of “Reserved”

next_appointment_bookingstring date-time

Date and time of next (soonest in the future) Booking in the Status of “Reserved”

wodify_validation_resultstring

Error message, if applicable

Example response

{
  "id": 1234567891234567,
  "client_status_id": 1234567891234567,
  "location_id": 1234567891234567,
  "default_program_id": 1234567891234567,
  "date_of_birth": "2014-12-31",
  "gender_id": 1234567891234567,
  "state_id": 1234567891234567,
  "country_id": 1234567891234567,
  "timezone_id": 1234567891234567,
  "weight": 0.1,
  "group": {
    "group_id": 1234567891234567,
    "group_role_id": 1234567891234567,
    "other_group_participants": [
      {
        "group_participant_client_id": 1234567891234567,
        "group_role_id": 1234567891234567
      }
    ]
  },
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "status_history": [
    {
      "from_status_id": 1234567891234567,
      "to_status_id": 1234567891234567,
      "status_change_datetime": "2014-12-31T23:59:59.938Z"
    }
  ],
  "last_attendance": "2014-12-31T23:59:59.938Z",
  "member_since": "2014-12-31",
  "last_contacted": "2014-12-31",
  "retain_snooze_until_date": "2014-12-31",
  "lead_id": 1234567891234567,
  "lead_source_id": 1234567891234567,
  "referring_user_id": 1234567891234567,
  "roles": [
    {
      "id": 1234567891234567
    }
  ],
  "available_programs": [
    {
      "program_id": 1234567891234567
    }
  ],
  "client_owner_id": 1234567891234567,
  "last_class_sign_in": "2014-12-31T23:59:59.938Z",
  "last_booking_sign_in": "2014-12-31T23:59:59.938Z",
  "current_weekstreak_updatedon": "2014-12-31T23:59:59.938Z",
  "next_class_reservation": "2014-12-31T23:59:59.938Z",
  "next_appointment_booking": "2014-12-31T23:59:59.938Z",
  "coach_services": [
    {
      "id": 1234567891234567,
      "service_icon_id": 1234567891234567,
      "durations": [
        {
          "id": 1234567891234567
        }
      ],
      "cancellation_policy": {
        "cancellation_unit_of_time_id": 1234567891234567,
        "cancellation_fee": 0.1,
        "cancellation_fee_tax_rate_id": 1234567891234567
      },
      "no_show_policy": {
        "no_show_fee": 0.1,
        "no_show_fee_tax_rate_id": 1234567891234567
      },
      "location_providers": [
        {
          "id": 1234567891234567,
          "location_id": 1234567891234567,
          "providers": [
            {
              "provider_id": 1234567891234567
            }
          ]
        }
      ],
      "bookings_open_time_window_unit_of_time_id": 1234567891234567,
      "bookings_close_time_window_unit_of_time_id": 1234567891234567,
      "waivers": [
        {
          "waiver_id": 1234567891234567
        }
      ],
      "created": {
        "created_by_id": 1234567891234567,
        "created_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "updated": {
        "updated_by_id": 1234567891234567,
        "updated_on_datetime": "2014-12-31T23:59:59.938Z"
      }
    }
  ],
  "coach_programs": [
    {
      "program_id": 1234567891234567
    }
  ],
  "coach_locations": [
    {
      "location_id": 1234567891234567
    }
  ]
}