GET: ALL CLIENTS
Type:
GET
Method:
clients
Parameter:
(integer)
{start} / {limit}
URL Example:
https://www.bizstim.com/api/clients/0/1000
start
parameter refers to the first record to return. Default = 0.limit
parameter refers to the number of records to return. Default = 1000. Maximum = 1000.start
and limit
can be omitted from the URL and their defaults will be chosen.total
key in the json object is the total number of records found. Use this to create your own pagination.ELEMENT | TYPE | DESCRIPTION |
---|---|---|
id |
integer | Unique id. |
users_id |
integer | Unique id. id on the users table |
client_settings_id |
integer | Unique id. id on the client_settings table |
avail_id |
integer | Unique id. id on the avail table |
first_name |
string | First name for the client |
last_name |
string | Last name for the client |
address1 |
string | Street address for the client |
address2 |
string | Suite or appartment number for the client |
city |
string | City location for the client |
state |
string | State location for the client |
zipcode |
string | Zipcode location for the client |
country |
string | Country location for the client |
p_phone |
string | Primary phone number for the client |
s_phone |
string | Secondary phone number for the client |
text_phone |
string | Text message phone number for the client. Comma separated list of mobile numbers |
email |
string | comma separated list of e-mails. Use LIKE query or convert string of e-mails to an array of e-mails to locate a client by their e-mail |
{ "status": "success", "total": 54, "response": [ { "id": "21", "users_id": "654", "client_settings_id": "42", "avail_id": "503", "first_name": "Joe", "last_name": "Smith", "address1": "6545 New Street East", "address2": "101", "city": "Milton", "state": "Ontario", "zipcode": "L7D 5S2", "country": "Canada", "p_phone": "(905) 454-6464", "s_phone": "(416) 567-1144", "text_phone": "19054546464", "email": "email1@mail.com,email2@mail.com,email3@mail.com" }, { ... } ] }
GET: CLIENT
Type:
GET
Method:
client
Parameter:
(integer)
{client_id}
URL Example:
https://www.bizstim.com/api/client/21
ELEMENT | TYPE | DESCRIPTION |
---|---|---|
id |
integer | Unique id. |
users_id |
integer | Unique id. id on the users table |
client_settings_id |
integer | Unique id. id on the client_settings table |
avail_id |
integer | Unique id. id on the avail table |
qb_customer_id |
integer | Unique id. id on the clients table |
first_name |
string | First name for the client |
last_name |
string | Last name for the client |
address1 |
string | Street address for the client |
address2 |
string | Suite or appartment number for the client |
city |
string | City location for the client |
state |
string | State location for the client |
zipcode |
string | Zipcode location for the client |
country |
string | Country location for the client |
p_phone |
string | Primary phone number for the client |
s_phone |
string | Secondary phone number for the client |
text_phone |
string | Text message phone number for the client |
status |
string | Status types include: active, inactive, prospect |
inactive_date |
string | Format: YYYY-MM-DD. For example: 2020-04-28 |
funnel_id |
integer | ID for the funnel table |
calendar_color |
string | Hex color code: e.g. #8874bc |
start_date |
string | Format: YYYY-MM-DD. For example: 2020-04-28 |
notes |
string | Information on the client |
timezone |
string | Client timezone |
send_welcome_message |
integer | 0 = no, 1 = yes |
send_lesson_reminders |
integer | 0 = no, 1 = yes |
add_session |
integer | 0 = no, 1 = yes |
see_practs_information |
integer | 0 = no, 1 = yes |
text_reminders |
integer | 0 = no, 1 = yes |
use_records |
integer | 0 = no, 1 = yes |
session_cancel |
integer | 0 = no, 1 = yes |
ace |
integer | Available credit exception. 0 = no, 1 = yes |
hide costs |
integer | Hide costs from the client. 0 = no, 1 = yes |
email |
string | String of comma separated emails: e.g. email1@mail.com,email2@mail.com |
calendar |
1 = month, 2 = week, 3 = day | |
minTime |
string | Default = 08:00:00 |
maxTime |
string | Default = 24:00:00 |
slotDuration |
string | Default = 00:15:00 or 15 minute intervals |
sessionLimit |
integer | Number of sessions to show per day in month view. Default = 10 |
cal_length |
integer | Length of the calendar on the page in pixels. Default = 1200 |
{ "status": "success", "response": { "id": "21", "users_id": "654", "client_settings_id": "42", "avail_id": "503", "first_name": "Joe", "last_name": "Smith", "address1": "6545 New Street East", "address2": "101", "city": "Milton", "state": "Ontario", "zipcode": "L7D 5S2", "country": "Canada", "p_phone": "(905) 454-6464", "s_phone": "(416) 567-1144", "text_phone": "19054546464" "status": "active" "inactive_date": "2022-04-21" "funnel_id": "125" "calendar_color": "#8874bc" "start_date": "2020-04-21" "notes": "This is a wonderful not for a fictitional student names Joe Smith." "send_welcome_message": "0" "send_lesson_reminders": "1" "add_session": "0" "see_practs_information": "1" "text_reminders": "1" "user_records": "0" "email": "susan@mail.com, joe@mail.com" "calendar": "1" "minTime": "11:30:00" "maxTime": "22:00:00" "slotDuration": "00:15:00" "sessionLimit": "10" "cal_length": "1200" } }
GET: ALL TESTIMONIALS
Type:
GET
Method:
testimonials
Parameter:
none
URL Example:
https://www.bizstim.com/api/testimonials
ELEMENT | TYPE | DESCRIPTION |
---|---|---|
id |
integer | Unique id. Testimonials id. |
first_name |
string | The client's first name |
last_name |
string | The client's last name |
testimonial |
string | The client testimonial |
{ "status": "success", "response": [ { "id": "54", "first_name": "Joe", "last_name": "Smith", "testimonial": "<p>an posuere sapien, eu tempus sapien porta in. Curabitur posuere neque non quam hendrerit ornare. Mauris ut molestie lorem. Aenean varius magna in vehicula ultrices. Nullam euismod consequat erat, ut vestibulum purus egestas at. Aenean ultrices, quam pellentesque auctor finibus, enim risus porttitor</p>" }, { "id": "72", "first_name": "Beth", "last_name": "Adder", "testimonial": "<p>an posuere sapien, eu tempus sapien porta in. Curabitur posuere neque non quam hendrerit ornare. Mauris ut molestie lorem. Aenean varius magna in vehicula ultrices. Nullam euismod consequat erat, ut vestibulum purus egestas at. Aenean ultrices, quam pellentesque auctor finibus, enim risus porttitor an posuere sapien, eu tempus sapien porta in. Curabitur posuere neque non quam hendrerit ornare. Mauris ut molestie lorem. Aenean varius magna in vehicula ultrices.</p>" }, { ... } ] }