---
title: "Get Employees"
method: GET
path: "/customers/employees"
tags: ["Employee"]
---

# Get Employees

`GET /customers/employees`

Get a list of employees.

## Query parameters

- `sort` string
- `page` integer
- `page_size` integer

## Headers

- `x-api-key` string, required

## Response `200`

Employee Data

- ResponseEmployees — Returns a list of Employees
  - `Employees` ClientsResponse[]
    - `id` integer — ClientId
    - `first_name` string — Client's First Name
    - `last_name` string — Client's Last Name
    - `email` string — Clien'ts Email Address
    - `phone_number` string — Client's Phone Number
    - `client_status_id` integer — Client's Status Id
    - `client_status` string — Client's Status
    - `location_id` integer — Client's Location Id
    - `location` string — Client's Location
    - `default_program_id` integer — Default GymProgram (GymProgramId on MemberSettings table)
    - `default_program` string — Default GymProgram Label
    - `date_of_birth` string, date — Client's Date of Birth
    - `gender_id` integer — Client's Gender Id
    - `gender` string — Client's Gender
    - `street_address_1` string — Client's Street Address 1
    - `street_address_2` string — Client's Street Address 2
    - `city` string — Client's City
    - `state_id` integer — Client's State Id
    - `state` string — Client's State
    - `province` string — Client's Province
    - `zipcode` string — Client's Zipcode
    - `country_id` integer — Client's Country Id
    - `country` string — Client's Country
    - `timezone_id` integer — Client's TimeZone Id
    - `timezone` string — Client's TimeZone
    - `height_measurement_1` integer — The 1st component of the user's height measurement. (Feet or meters depending on the UOM chosen).
    - `height1_system_of_measure` string — System of Measure for Height 1
    - `height_measurement_2` integer — The 2nd component of the user's height measurement. (Inches or centimeters depending on the UOM chosen).
    - `height2_system_of_measure` string — System of Measure for Height 2
    - `weight` number — Client's Weight
    - `weight_system_of_measure` string — Customer's system of measurement for weight and height.
    - `is_email_subscribed` boolean — Determines if the Client is subscribed to receive emails
    - `is_sms_subscribed` boolean — Determines if the Client is subscribed to receive SMS
    - `tags` string[] — Client's Tags
    - `created_on` Created — Record creation data.
      - `created_by_id` integer — Unique ID of the user that created the record.
      - `created_by` string — Name of the user that created the record.
      - `created_on_datetime` string, date-time — Datetime on which the record was created.
    - `updated` Updated — Update info
      - `updated_by_id` integer — Unique ID of the user that last updated the record.
      - `updated_by` string — Name of the user that most recently updated the record.
      - `updated_on_datetime` string, date-time — Datetime on which the record was last updated.
    - `emergency_contact_name` string — Client's Emergency Contact
    - `emergency_contact_phone` string — Client's Emergency Contact Phonne Number
    - `last_attendance` string, date-time — Datetime that the Clien't last attended a class/session/appointment.
    - `days_since_last_attendance` integer — Number of days since the Client last attended
    - `member_since` string, date — The Date the Client has been a member since
    - `last_contacted` string, date — Date the Client was last contacted
    - `is_at_risk` boolean
    - `retain_snooze_until_date` string, date — Retain Snooze Until Date
    - `lead_source_id` integer — The Id of the Lead Source if the Client was converted from a Lead
    - `lead_source` string — The Lead Source if the Client was converted from a Lead
    - `referring_user_id` integer — The Id of the User that referred the Lead, if the Client was converted from a Lead
    - `referring_user` string — The Name of the User that referred the Lead, if the Client was converted from a Lead
    - `is_converted_from_lead` boolean — Indicates if the Client was converted from a Lead
    - `client_owner_id` integer — user id of client owner
    - `client_owner` string — name of client owner
    - `total_class_sign_ins` integer — Total number of Classes the Client has signed into.
    - `total_booking_sign_ins` integer — Total number of Appointment Bookings the Client has signed into.
    - `last_class_sign_in` string, date-time — Date and time of the last Class the Client has signed into.
    - `last_booking_sign_in` string, date-time — Date and time of the last Appointment Booking the Client has signed into.
    - `current_weekstreak` integer — Clients Current weekstreak
    - `highest_weekstreak` integer — Clients Highest weekstreak
    - `current_weekstreak_updatedon` string, date-time — The last time the user had their weekstreak updated on.
    - `coach_title` string — coach title
    - `coach_bio` string — coach biography html
    - `is_display_coach_on_mobile_app` boolean — Is Display On Mobile App
    - `coach_link_1_icon` string — coach link 1 icon
    - `coach_link_1_url` string — coach link 1 url
    - `coach_link_2_icon` string — coach link 2 icon
    - `coach_link_2_url` string — coach link 2 url
    - `coach_link_3_icon` string — coach link 3 icon
    - `coach_link_3_url` string — coach link 3 url
    - `coach_link_4_icon` string — coach link 4 icon
    - `coach_link_4_url` string — coach link 4 url
    - `coach_link_5_icon` string — coach link 5 icon
    - `coach_link_5_url` string — coach link 5 url
    - `next_class_reservation` string, date-time — Date and time of next (soonest in the future) Reservation in the Status of “Reserved”
    - `next_appointment_booking` string, date-time — Date and time of next (soonest in the future) Booking in the Status of “Reserved”
  - `Pagination` Pagination — Pagination for API method responses.
    - `page` integer, required — Current page number.
    - `page_size` integer, required — Number of records per page.
    - `has_more` boolean, required — True if more records exist beyond the current page.
  - `wodify_validation_result` string — The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions: - an UserException with Abort Transaction = Yes, and a Log Error = No - an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

---

[API](https://skmtc.net/wodify/apis/leads.md) · [All operations](https://skmtc.net/wodify/apis/leads/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wodify/leads/revisions/974500ca0714/schema)