These are the endpoints that are available under the /clients path, which shows profiles of the clients on your business' account.
Endpoint | Description | |||||
---|---|---|---|---|---|---|
GET /clients | Returns all client objects on an account in array format. | |||||
GET /clients/{clientId} | Returns a JSON object for specified client. | |||||
GET /clients/count | Returns the number of active clients on an account. Used in app to create pagination on client's list. | |||||
GET /clients/tags | Returns strings of tags in array format that are assigned to the specified client. | |||||
GET /clients/canViewedBy/{clientAccountId} | Returns an array of client objects that can access specified clientAccountId when they login to the public scheduler | |||||
GET /clients/canView/{clientId} | Returns an array of client objects that the specified client can access when they login to the public scheduler | |||||
GET /clients/externalUserName/{externalUserName} | Returns an array of client objects for any clients matching the specified externalUserName. Optional Parameter: includeDeleted=true can be added as a request parameter to include any previously deleted clients in the results. Defaults to false. Example: /clients/externalUserName/{externalUserName}?includeDeleted=true | |||||
GET /clientList/reportWithCount | Returns an object that contains a list of clients along with a count of the total number of clients that match the parameters passed with the call. | |||||
GET /clientList/report | Returns an object that contains a list of clients that match the parameters passed with the call. | |||||
GET /clientList/reportCount | Returns a count object that provides the number of clients that match the parameters passed with the call. | |||||
GET /clientIdList | Returns an object that contains list of the client IDs for the clients that match the parameters passed with the call. | |||||
POST /clients | Creates a new client object on an account. Request body/payload: Pass a client object with all required fields defined. For these calls, you need to pass a clients object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a clients object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. | |||||
POST /clients/filterTag | Returns all client objects that have the tag passed in the request body assigned to them in array format. | |||||
POST /clients/filter | Returns all client objects matching the search parameters used in array format. Returns an object with clientId = -1 in the array for adding a new client. Request body/payload: Pass search string in body of post. | |||||
POST /clients/dupecheck/email | Returns all client objects that have specified email address in array format. If none qualify, returns an empty array. Request body/payload: Pass the email address in the body of the post. | |||||
POST /clients/merge/{clientId} | Merges a client's account with another account of specified client. Request body/payload: Pass an array of clients getting merged. | |||||
PUT /clients/{clientId} | Updates an existing client object. Request body/payload: Pass a client object with all required fields defined. For these calls, you need to pass a clients object with all required fields and any fields you want to update filled in the body of the payload. We have an example of a clients object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. | |||||
PATCH /clients/{clientIid} | Updates an existing client object with the items to be updated defined in the request body. Allows users to send partial data through API and uses that to update the object. Request body/payload: Pass a client object with the field(s) you wish to update defined. For example,
| |||||
DELETE /clients/{clientId} | Removes a client object from view by setting its active property to false. |
Data points passed on in the request URL portion of the API call that are used to filter the data that is being requested. To improve load times, when getting list of full clients can pass a pageNumber and pageSize parameter to reduce total returned number of values.
Parameter | Type | Endpoints to be used with | Description |
---|---|---|---|
clientIdList | integer array | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as a list of the IDs for clients to return following the API call. |
endDate | string | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as the created date of the clients to return following the API call. |
locationGroupIdList | integer array | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as a list of the IDs of location groups that contain locations where clients to return following the API call had appointments scheduled. |
locationIdList | integer array | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as a list of the IDs of locations where clients to return following the API call had appointments scheduled. |
order_field | object | GET /clients, POST /clients/filter, GET /clientList/reportWithCount, GET /clientList/report | Displays the field name used to order the data that gets returned following a GET call. Available options are fullName and emailAddress. |
order_mode | object | GET /clients, POST /clients/filter, GET /clientList/reportWithCount, GET /clientList/report | Displays the order type that is used to order the data that gets returned following a GET call. Available options are "asc" for ascending and "desc" for descending. |
pageNumber | integer | GET /clients, GET /clientList/reportWithCount, GET /clientList/report | Works with the pageSize parameter to determine how data gets returned following a GET call. The pageNumber value represents the number of pages on which the clients that get returned appear. |
pageSize | integer | GET /clients, GET /clientList/reportWithCount, GET /clientList/report | Works with the pageNumber parameter to determine how data gets returned following a GET call. The pageSize value represents the number of clients appearing on each page of clients that gets returned. |
reasonIdList | integer array | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as a list of the IDs of reasons that clients to return following the API call had appointments scheduled for. |
searchTerm | string | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Searches values of custom fields or of any notes added to client's profile. |
showClientForms | boolean | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | If set to true, will add an extra query to add the clients' disclaimer forms to the client object to return following the API call. |
staffIdList | integer array | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as a list of the IDs of staff that clients to return following the API call had appointments scheduled with. |
startDate | string | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as the created date of the client to return following the API call. |
statusList | string | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as any of the values stored on the status property of clients to return following the API call. |
tagsList | string | GET /clientList/reportWithCount, GET /clientList/report, GET /clientList/reportCount, GET /clientIdList | Should be set as any of the client tags of clients to return following the API call. |
The objects below represent the minimum viable objects to pass that are needed to create or update a clients object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "allowWaitListText": true, "clientIdsClientCanView": [], "fields": [{Fields object for scheduler fields of client - see Scheduler Fields API page}], "locale": "en-US", "tags": [], "timeZone": {Timezone object for timezone of client - see Timezones API page} } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Jane Doe |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "joel@timetap.com" } [This will be whatever email address you entered to check for duplicates.] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "allowWaitListText": false, "cellPhone": null, "clientAccountId": 1151042, "clientId": 4922146, "clientIdsClientCanView": [], "companyName": null, "createdDate": 1530215432220, "createdUser": "JoeSchmo", "dateOfBirth": null, "deleted": false, "emailAddress": "john@email.com", "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": [{Fields object for scheduler fields of client - see Scheduler Fields API page}], "firstName": "John", "fullName": "John Doe", "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Doe", "locale": "en-US", "modifiedDate": 1530215765388, "modifiedUser": "MORGANKEARNEY", "notes": null, "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": [], "timeZone": {Timezone object for timezone oof client - see Timezones API page}, "timeZoneCode": {timeZoneId: null, timeZoneCode: null, timeZoneDesc: null, visible: null, sortOrder: null}, "viewClientAccountIds": [1151044] } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "address1: null, "address2: null, "alertNotes": null, "allowWaitListText": null, "authnetCustomerId": null, "businessId": 43111, "cellPhone": null, "city": "Charlotte", "clientAccountId": 1151035, "clientId": 4658091, "companyName": null, "country": null, "county": null, "createdDate": 15239802546289, "createdUser": "JoeSchmo", "dateOfBirth": null, "deleted": false, "emailAddress": "noreply@email.com", "excludeEmailCategoryIdList": null, "excludeEmailTemplateIdList": null, "externalUserName": null, "fields": {Scheduler fields object for client - see Scheduler Fields API page}, "firstName": "Johnny", "formList": null, "fullName": "Johnny Begood", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "invitationOptIn": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Begood", "locale": null, "modifiedDate": null, "modifiedUser": null, "notes": null, "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "salesforcePersonId": null, "sex": null, "squareCustomerId": null, "ssn": null, "state": "NC", "status": "Active", "stripeCustomerId": null, "tags": ["Excellent"], "timeZone": {Timezone object for timezone of client - see Timezones API page}, "timeZoneCode": {Timezone object for timezone of client - see Timezones API page}, "viewByClients": null, "viewClientAccountIds": null, "viewClients": null, "zip": null }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "address1: null, "address2: null, "alertNotes": null, "allowWaitListText": null, "authnetCustomerId": null, "businessId": 43111, "cellPhone": null, "city": "Charlotte", "clientAccountId": 1151035, "clientId": 4658091, "companyName": null, "country": null, "county": null, "createdDate": 15239802546289, "createdUser": "JoeSchmo", "dateOfBirth": null, "deleted": false, "emailAddress": "noreply@email.com", "excludeEmailCategoryIdList": null, "excludeEmailTemplateIdList": null, "externalUserName": null, "fields": {Scheduler fields object for client - see Scheduler Fields API page}, "firstName": "Johnny", "formList": null, "fullName": "Johnny Begood", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "invitationOptIn": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Begood", "locale": null, "modifiedDate": null, "modifiedUser": null, "notes": null, "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "salesforcePersonId": null, "sex": null, "squareCustomerId": null, "state": "NC", "status": "Active", "stripeCustomerId": null, "tags": ["Excellent"], "timeZone": {Timezone object for timezone of client - see Timezones API page}, "viewClientAccountIds": null } |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ 46 } |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ 0: "Excellent", 1: "Rotund" ] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "activeAppointmentCount": null, "address1": null, "address2": null, "aggregatedNotes": null, "allowWaitListText": null, "authnetCustomerId": null, "authnetPaymentProfileIdList": null, "blocked": false, "businessId": 43111, "businessPhone": null, "cellPhone": "555-1234", "city": null, "clientAccountId": 1151035, "clientId": 4658091, "companyName": null, "country": null, "county": null, "createdDate": 1523982546289, "createdUser": "JoeSchmo", "dateOfBirth": 728611200000, "deleted": false, "emailAddress": "johnny@email.com", "emergencyContact": null, "emergencyContactPhone": null, "enrollee": null, "enterpriseClientId": null, "excludeEmailCategoryIdList": null, "excludeEmailTemplateIdList": null, "externalUserName": null, "fieldDataList": [{ "schedulerPreferenceFieldDefnId": 322516, "value": "Johnny" },{ "schedulerPreferenceFieldDefnId": 322517, "value": "Begood" },{ "schedulerPreferenceFieldDefnId": 322518, "value": "Johnny Begood" },{ "schedulerPreferenceFieldDefnId": 322520, "value": "noreply@email.com" }], "fieldDataListJson": [{"schedulerPreferenceFieldDefnId": 322516,"value":"Johnny"},{"schedulerPreferenceFieldDefnId":322517,"value": "Begood"},{"schedulerPreferenceFieldDefnId":322518,"value":"Johnny Begood"},{"schedulerPreferenceFieldDefnId": 322520,"value": "noreply@email.com"}], "fieldDataMap": {322516: "Johnny", 322517: "Begood", 322518: "Johnny Begood", 322520: "noreply@email.com"}, "fieldDataMapJson": "{"322516":"Johnny","322517":"Begood","322518":"Johnny Begood","322520":"noreply@email.com"}", "fields": null, "firstName": "Johnny", "formList": null, "fullName": "Johnny Begood", "homePhone": null, "hubspotutk": null, "imageUrl": null, "infusionsoftContactId": null, "insuranceCo": null, "insuranceGroup": null, "insuranceNo": null, "insurancePlan": null, "invitationOptIn": null, "ipAddress": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Begood", "latitude": null, "locale": null, "longitude": null, "modifiedDate": 1530215760466, "modifiedUser": "JoeSchmo", "parentBusinessId": null, "referredBy": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "safeDateOfBirth": null, "salesforceAccountId": null, "salesforceContactId": null, "salesforceLeadId": null, "salesforcePersonId": null, "sanitized": false, "sex": null, "spouseName": null, "squareCustomerId": null, "ssoTags": null, "state": null, "status": "Active", "stripeCustomerId": null, "tags": [], "textSearchable": "Johnny Begood noreply@email.com Johnny Begood Johnny Begood noreply@email.com", "timeZoneCode": null, "viewClientAccountIds": [1151044] "zip": null }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "activeAppointmentCount": null, "allowWaitListText": null, "authnetCustomerId": null, "authnetPaymentProfileIdList": null, "businessId": 43111, "businessPhone": null, "cellPhone": null, "clientAccountId": 1151044, "clientId": 4761823, "companyName": null, "createdDate": 1526388401719, "createdUser": "JoeSchmo", "dateOfBirth": null, "deleted": false, "emailAddress": "janedeer@email.com", "emergencyContact": null, "emergencyContactPhone": null, "enrollee": null, "enterpriseClientId": null, "excludeEmailCategoryIdList": null, "externalUserName": null, "fieldDataList": [{ "schedulerPreferenceFieldDefnId": 322516, "value": "Jane" },{ "schedulerPreferenceFieldDefnId": 322517, "value": "Deer" },{ "schedulerPreferenceFieldDefnId": 322518, "value": "Jane Deer" },{ "schedulerPreferenceFieldDefnId": 322520, "value": "janedeer@email.com" }], "fieldDataListJson": [{"schedulerPreferenceFieldDefnId": 322516,"value":"Jane"},{"schedulerPreferenceFieldDefnId":322517,"value":"Deer"},{"schedulerPreferenceFieldDefnId":322518,"value":"Jane Deer"},{"schedulerPreferenceFieldDefnId":322520,"value":"janedeer@email.com"}], "fieldDataMap": {322516: "Jane", 322517: "Deer", 322518: "Jane Deer", 322520: "janedeer@email.com"}, "fieldDataMapJson": "{"322516":"Jane","322517":"Deer","322518":"Jane Deer","322520":"janedeer@email.com"}", "fields": null, "firstName": "Jane", "fullName": "Jane Deer", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "insuranceCo": null, "insuranceGroup": null, "insuranceNo": null, "insurancePlan": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Deer", "latitude": null, "locale": null, "longitude": null, "modifiedDate": 1530215760466, "modifiedUser": "JoeSchmo", "parentBusinessId": null, "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "safeDateOfBirth": null, "salesforceAccountId": null, "salesforceContactId": null, "sex": null, "spouseName": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": [], "textSearchable": "Jane Deer janedeer@email.com Jane Deer Jane Deer janedeer@email.com", "viewClientAccountIds": [] }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "clients": [ { "allowWaitListText": null, "cellPhone": null, "clientAccountId": 1151042, "clientId": 4922146, "companyName": null, "createdDate": 1530215432220, "createdUser": "JoeSchmo", "dateOfBirth": null, "deleted": false, "emailAddress": "john@email.com", "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": {Scheduler fields object for client - see Scheduler Fields API page}, "firstName": "John", "fullName": "John Doe", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Doe", "locale": "en-us", "modifiedDate": 1530215765388, "modifiedUser": "JoeSchmo", "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": [], "timeZone": {Timezone object for timezone of client - see Timezones API page}, "viewClientAccountIds": [1151044] }], "ccount": 47} |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "allowWaitListText": null, "cellPhone": null, "clientAccountId": 1151042, "clientId": 4922146, "companyName": null, "createdDate": 1530215432220, "createdUser": "JoeSchmo", "dateOfBirth": null, "deleted": false, "emailAddress": "john@email.com", "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": {Scheduler fields object for client - see Scheduler Fields API page}, "firstName": "John", "fullName": "John Doe", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Doe", "locale": "en-us", "modifiedDate": 1530215765388, "modifiedUser": "JoeSchmo", "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": [], "timeZone": {Timezone object for timezone of client - see Timezones API page}, "viewClientAccountIds": [1151044] }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "count": 47 } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[ 4658091, 14062590, 6110946, 6865306, 7949146, 5901342, 13908832, 13864841, 7878140, 4761823, 13855267, 13855135, 5143212, 5147394, 5147404, 5147353, 6110900, 10915321, 10575898, 5146945, 5147093, 7594980, 7585627, 7579433, 7563061, 7475995, 7316309, 7134353, 6973283, 6865315, 6607828, 6601818, 6595850, 6581640, 6514061, 6450041, 6444669, 6334145, 5895933, 5360110, 5147422, 5147390, 5147382, 5147375, 5147362, 5146927, 4932331 ] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "allowWaitListText": true, "cellPhone": null, "clientAccountId": null, "clientId": 5966842, "companyName": null, "createdDate": null, "createdUser": null, "dateOfBirth": null, "deleted": null, "emailAddress": null, "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": [{Fields object for scheduler fields of client - see Scheduler Fields API page}], "firstName": null, "fullName": null, "imageUrl": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": null, "locale": "en-US", "modifiedDate": null, "modifiedUser": null, "notes": null, "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": null, "stripeCustomerId": null, "tags": [], "timeZone": {Timezone object for time zone of client - see Timezone API page}, "timeZoneCode": {timeZoneId: null, timeZoneCode: null, timeZoneDesc: null, visible: null, sortOrder: null}, "viewClientAccountIds": null } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
IF tagString entered matches a tag on your business account, response is that tag, or ["Excellent"] 0: "Excellent" IF tagString does not match any tags on your business account, response is an empty array. |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "allowWaitListText": null, "cellPhone": null, "clientAccountId": 1151035, "clientId": 4658091, "companyName": null, "createdDate": 15239802546289, "createdUser": "JoeSchmo", "dateOfBirth": null, "deleted": false, "emailAddress": "noreply@email.com", "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": {Scheduler fields object for client - see Scheduler Fields API page}, "firstName": "Johnny", "fullName": "Johnny Begood", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Begood", "locale": null, "modifiedDate": null, "modifiedUser": null, "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": [], "timeZone": {Timezone object for timezone of client - see Timezones API page}, "viewClientAccountIds": null },{ "allowWaitListText": null, "cellPhone": null, "clientAccountId": null, "clientId": -1, "companyName": null, "createdDate": null, "createdUser": null, "dateOfBirth": null, "deleted": null, "emailAddress": null, "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": null, "firstName": null, "fullName": "Add new client: noreply@email.com", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": null, "locale": null, "modifiedDate": null, "modifiedUser": null, "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": null, "timeZone": null, "viewClientAccountIds": null }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "allowWaitListText": null, "cellPhone": null, "clientAccountId": 1659456, "clientId": 7475995, "companyName": "", "createdDate": 1578418789490, "createdUser": "WebClient", "dateOfBirth": null, "deleted": false, "emailAddress": "joel@jmorgankearney.com", "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": null, "firstName": "Joel", "fullName": "Joel Test", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Test", "locale": "en-US", "modifiedDate": 1580307871243, "modifiedUser": "WebClient", "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": null, "timeZone:: {Timezone object for timezone of client - see Timezones API page}, "viewClientAccountIds": null, }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "allowWaitListText": null, "cellPhone": null, "clientAccountId": null, "clientId": 4935512, "companyName": null, "createdDate": 1538638448443, "createdUser": "JoeSchmo", "dateOfBirth": "1984-05-09", "deleted": false, "emailAddress": "hollyhoopz@email.com", "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": {Scheduler fields object for client - see Scheduler Fields API page}, "firstName": "Holly", "fullName": "Holly Hooper", "homePhone": null, "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Hooper", "locale": "en-us", "modifiedDate": 1530215760466, "modifiedUser": "JoeSchmo", "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": null, "timeZone": {Timezone object for timezone of client - see Timezones API page}, "viewClientAccountIds": null },{ "allowWaitListText": null, "cellPhone": "555-1234", "clientAccountId": 1155923, "clientId": 4932331, "companyName": null, "createdDate": 1530557261097, "createdUser": "JoeSchmo", "dateOfBirth": "1993-02-02", "deleted": false, "emailAddress": "jimmy@email.com", "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": {Scheduler fields object for client - see Scheduler Fields API page}, "firstName": "Jimmy", "fullName": "Jimmy Begood", "homePhone": "555-5555", "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Begood", "locale": null, "modifiedDate": null, "modifiedUser": null, "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": null, "timeZone": {Timezone object for timezone of client - see Timezones API page}, "viewClientAccountIds": null }] |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "allowWaitListText": null, "cellPhone": "555-555-1234", "clientAccountId": null, "clientId": 5143212, "clientIdsClientCanView": [4658091], "companyName": null, "createdDate": 1530557261097, "createdUser": "JoeSchmo", "dateOfBirth": "1993-02-02", "deleted": false, "emailAddress": "jimmy@email.com", "excludeEmailCategoryIdList": null, "externalUserName": null, "fields": {Scheduler fields object for client - see Scheduler Fields API page}, "firstName": "Jimmy", "fullName": "Jimmy Begood", "homePhone": "555-5555", "imageUrl": null, "infusionsoftContactId": null, "jobRequisitionNumbersAccepted": null, "jobRequisitionNumbersDeclined": null, "jobRequisitionNumbersSent": null, "lastName": "Begood", "locale": "en-us", "modifiedDate": 1530215760466, "modifiedUser": "JoeSchmo", "password": null, "requisitionIdsAccepted": null, "requisitionIdsDeclined": null, "requisitionIdsSent": null, "salesforceContactId": null, "sex": null, "squareCustomerId": null, "status": "Active", "stripeCustomerId": null, "tags": ["Excellent"], "timeZone": {Timezone object for timezone of client - see Timezones API page}, "viewClientAccountIds": [] } |
Property name | Type | Required | Writable | Description |
---|---|---|---|---|
address1 | string | Displays the first line of the specified client's address. | ||
address2 | string | Displays the second line of the specified client's address. | ||
alertNotes | array | Displays the notes objects associated with the specified client's account. | ||
allowWaitListText | boolean | Indicates whether or not the specified client's account is set to allow waitlist text messages. | ||
authnetCustomerId | integer | Provides the Authnet customer ID of the specified client. | ||
businessId | integer | Provides unique numeric ID for the business that the specified client belongs to. | ||
cellPhone | string | Yes | Displays the cell phone number of the specified client. | |
city | string | Displays as the city the specified client is from. | ||
clientAccountId | integer | Yes | If the client has registered on the scheduler or you have provided the client with a password to the scheduler, this would provide their unique numeric ID for the scheduler login. | |
clientId | integer | Yes, on PUT calls | Provides a unique numeric ID of the specified client's account as stored on TimeTap's back office. | |
companyName | string | Yes | Displays the name of the company the specified client associates with - is mapped from field in fields array where the property code on the field is equal to companyName. | |
country | string | Displays as the country the specified client is from. | ||
county | string | Displays as the county the specified client is from. | ||
createdDate | integer | Displays as the date the specified client's account was created, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
createdUser | string | Displays the username of user who created the specified client's account. | ||
dateOfBirth | string | Yes | Provides the date of birth of the specified client - is mapped from field in fields array where the property code on the field is equal to dateOfBirth | |
deleted | boolean | Indicates whether or not the specified client's account has been deleted. | ||
emailAddress | string | Yes | Yes | Displays the email address of the specified client - is mapped from field in fields array where the property code on the field is equal to emailAddress. |
excludeEmailCategoryIdList | array | Provides a list of email category IDs to exclude. If email category IDs are included in this array, the client will not receive emails that are assigned to that category. | ||
excludeEmailTemplateIdList | array | Provides a list of email template IDs to exclude. If email template IDs are included in this array, the client will not receive emails that use that template. | ||
externalUserName | string | Yes | Displays any external user names specified client might have. Is mapped from field in fields array where the property code on the field is equal to externalUserName. | |
fields | array | Yes | Yes | Displays the scheduler fields associated with specified client's account. |
firstName | string | Yes | Yes | Displays as first name of specified client. Is mapped from field in fields array where the property code on the field is equal to firstName. |
formList | array | Displays the DisclaimerFormData for the specified client's account in array form. | ||
fullName | string | Yes | Yes | Displays as full name of specified client. Is mapped from field in fields array where the property code on the field is equal to fullName. |
homePhone | string | Yes | Displays the home phone number of specified client. Is mapped from field in fields array where the property code on the field is equal to homePhone. | |
imageUrl | string | Yes | Provides the URL of profile image attached to specified client's account. | |
infusionsoftContactId | integer | Provides the Infusionsoft Contact ID of the specified client. | ||
invitationOptIn | boolean | Indicates whether or not the specified client's account has opted in to receive invitations. | ||
jobRequisitionNumbersAccepted | string | Displays a list of job requisition numbers that have been added to the specified clients profile. | ||
jobRequisitionNumbersDeleted | string | Displays a list of job requisition numbers that have been declined by specified client. | ||
jobRequisitionNumbersSent | string | Displays a list of job requisition numbers that have been sent to specified client. | ||
lastName | string | Yes | Yes | Displays as last name of specified client. Is mapped from field in fields array where the property code on the field is equal to lastName. |
locale | string | Provides the locale of specified client. If using language-specific email templates, this is used to determine which template to send to the client. | ||
modifiedDate | integer | Displays as date specified client's account was last updated in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
modifiedUser | string | Displays the username of user who last updated specified client's account. | ||
notes | string | Displays as any client notes that have been saved for the specified client. | ||
password | string | Yes | In updating or adding a client, you can set the password for the client to login to the scheduler by passing it in this field. Once set, this field will always return as null so passwords are not getting transmitted through GET calls on the API. You will know if the client has been registered on the scheduler by whether the clientAccountId property is filled in. | |
requisitionIdsAccepted | string | Displays a list of job requisition ids that have been added to the specified clients profile. These are the unique numeric ids of the requisition numbers that are stored in the jobRequisitonNumbersAccepted array. | ||
requisitionIdsDeclined | string | Provides a list of requisition IDs declined by specified client's account. These are the unique numeric ids of the requisition numbers that are stored in the jobRequisitonNumbersDeclined array. | ||
requisitionIdsSent | string | Provides a list of requisition IDs sent to specified client's account. These are the unique numeric ids of the requisition numbers that are stored in the jobRequisitonNumbersSent array. | ||
salesforceContactId | integer | If account is using the Salesforce integration and this client has been passed to or from salesforce, this property will fill in with the ID of the client/lead record in Salesforce. | ||
salesforcePersonId | string | If account is using the Salesforce integration and this client has been passed to or from salesforce, this property will fill in with the Salesforce linked person ID. | ||
sex | string | Yes | Displays as the sex of the specified client. Is mapped from field in fields array where the property code on the field is equal to sex. | |
squareCustomerId | integer | Yes | If account is using the Square integration as payment portal and this client has been passed to square to put in his/her credit card information, this property will fill in with the ID of the client record in Square. | |
ssn | integer | Provides the social security number of the specified client. | ||
state | string | Displays as the state the specified client is from. | ||
status | string | Yes | Displays the status of specified client's account. Possible values include Active and Blacklisted. | |
stripeCustomerId | integer | If account is using the Stripe integration as payment portal and this client has been passed to square to put in his/her credit card information, this property will fill in with the ID of the client record in Stripe. | ||
tags | array | Provides any tags that may be associated with specified client's account. Set as an array of strings. | ||
textSearchable | string | Provides a string of text that you can search for that will return the specified group. | ||
timeZone | object | Displays the timezone specified client's account is set to - for more info, see Timezones API page. | ||
timeZoneCode | string | Displays the timezone code associated with the specified client's account. | ||
viewByClients | array | Provides the clientId of any other clients that are allowed to view this client. | ||
viewClientAccountIds | array | Yes | Provides a list of clientAccountIds who could login to the scheduler and view this client's appointments as well as make appointments on this clients behalf. | |
viewClients | array | Provides the clientId of any other clients that this client is allowed to view. | ||
zip | string | Displays as the zip code the specified client is from. |