Sign in

v1

latestOpenAPI 3.0.02026-07-1326037.0 KB
Customers

Get filtered customer data

get/v1/customers/facility/{facilityCode}

Path parameters

facilityCodestring required

Facility code

Query parameters

type'GUEST' | 'PUNCH CARD' | 'MEMBER' | 'CORPORATE'

Return customers with a specified type

status'TERMINATED' | 'FROZEN' | 'EXPIRED' | 'OK'

Return customers with a specified status

waiverSignedboolean

Return customers with a specified waiver signing status

birthdayMonthinteger

Return customers with a specified birth date month

birthdayUpcominginteger

Return customers with a birth date within a specified number of days

firstContactDateEndingstring

Return customers with a first contact date before or equal to the date specified (yyyy-mm-dd)

firstContactDateStartingstring

Return customers with a first contact date after or equal to the date specified (yyyy-mm-dd)

lastVisitDateEndingstring

Return customers with a last visit date date before or equal to the date specified (yyyy-mm-dd)

lastVisitDateStartingstring

Return customers with a last visit date after or equal to the date specified (yyyy-mm-dd)

lastEditDateEndingstring

Return customers with a last edit date date before or equal to the date specified (yyyy-mm-dd)

lastEditDateStartingstring

Return customers with a last edit date after or equal to the date specified (yyyy-mm-dd)

firstNamestring

Return customers with a specified first name (% wildcard is allowed)

middleNamestring

Return customers with a specified middle name (% wildcard is allowed)

lastNamestring

Return customers with a specified last name (% wildcard is allowed)

citystring

Return customers with a specified address city (% wildcard is allowed)

statestring

Return customers with a specified address state (% wildcard is allowed)

postalCodestring

Return customers with a specified address postal code (% wildcard is allowed)

countrystring

Return customers with a specified address country (% wildcard is allowed)

ageGreaterThaninteger

Return customers with an age in years greater than or equal to a specified number

ageLessThaninteger

Return customers with an age in years less than or equal to a specified number

onlineAccountLinkedboolean

Return customers with a specified online account link status

emailAddressPopulatedboolean

Return customers with a specified email address entered status

emailAllowMarketingboolean

Return customers with a specified email marketing status

emailTouchDateEndingstring

Return customers with an email address created or updated before or equal to the date specified (yyyy-mm-dd)

emailTouchDateStartingstring

Return customers with an email address created or updated after or equal to the date specified (yyyy-mm-dd)

emailAddressstring

Return customers with a specified email address (% wildcard is allowed)

limitinteger

Results per page

pageinteger

Result page

Response

Success