Getting Started
To start using the GigaBook API to communicate with third party services, you need to set up a linked application to our API settings page. Here's how:
- Navigate to Settings > Account > API Settings
- You will see a list of your applications linked to GigaBook. Click the “ADD” button to add a new one.
- Input the name of your application in the “Name” field
- Enter the URL of your application's callback API script (similar to http://domain.com/callback_url) in the “Callback URL” input field
- Click all the appropriate checkboxes in the Scope list
- Click “Add” button
- That's it, you're all set up! Your application will display in the list.
Next Up: Authentication
Authentication
GigaBook's REST APIs uses OAuth 2.0. The following walkthrough will show you how a client application can securely authenticate to use the GigaBook API. Before a client application can begin calling the GigaBook APIs, a GigaBook administrator will need to create a Custom Service.
Custom Services allow a GigaBook administrator to set granular access permissions for a specific client application to use. Any client application that attempts to insvoke APIs that are not within the access permissions granted will receive an error.
Tokens retrieved through the identity endpoint will expire X seconds in the future, where X is the value of "expires_in" in the identity response. The expiration period upon creation is 1 hour. If there is a further authentication call for the same client Id during this period, the same token will be returned and the remainder of the period will be reported in expires_in.
NOTE: Custom Services are recommended for GigaBook Customer's development teams use of the GigaBook REST APIs.
How to Generate an Access Token
Client applications must use a Custom Service's client id and client secret to generate a valid access token. The access token must then be passed when invoking any of the REST API
Endpoints.All authorization requests are submitted to the REST API identity service URL located within the GigaBook Settings → Account → API settings:
Token Management
Access tokens for GigaBook’s REST API should be held and reused until expiration. The response form the identity endpoint will report a field “expires_in” which represents the remaining lifetime of the token in seconds. The lifetime of the token should be held in the client application and if a token is known to be expired it should be renewed with the identity service by calling the retrieve an access token again.
URL: https://gigabook.com/authorize
Method: GET
| Parameters | Required/Optional | Description |
| response_type | Required | Type of response (response_type=code) |
| uri | Required | Link to the client API https://myapi.com/oautho |
| client_id | Required | GigaBook’s>Settings>Account>API settings
(Application ID is the client_id) |
| client_secret | Required | GigaBook’s>Settings>Account>API settings
(Application Secret is the client_secret) |
Redirect to:
https://gigabook.com/authorize?response_type=code&client_id=yourClient
Id&client_secret=yourClientSecret&redirect_uri=customUri&state=xyz
In case successful validation → You will be redirected to Authorization form of GigaBook’s user.
In case successful authorization → Gigabook will response parameter of authorization code to the client server by GET string “code=code” Client’s application send JSON string by POST method to the url: https://gigabook.com/authorize/token
Example
JSON
{
“code” : “code”,
“client_id”: “1232r2r2”,
“client_secret”: “232r232d2re”,
“grant_type”: “authorization_code”,
“scope”: “userinfo”,
“redirect_uri”: “https://gigabook.com/authorize?response_type=code&client_id=yourClientId&client_secret=yourClientSecret&redirect_uri=customUri&state=xyz”
}
Response by POST
Note: expires_in is returned in seconds
JSON
{
"access_token":"83f2e5b6cd62af312f94723587d9025df0325e2d",
"expires_in":3600,
"token_type":"Bearer",
"scope":"userinfo",
"refresh_token":"e459564628db76371e8fcafd77ebce6e087736df"
}
NOTE: API requests are case insensitive
You will get this response after each authorization:
JSON
If successfully:
{
"success": “true”,
"error":” false”,
"error_message": "”,
"data": “data array”
}
Unless successfully:
{
"success": “false”,
"error":” true”,
"error_message": "Error message”,
"data": “”
}
Each REST call (ADD/DELETE/RESTORE/EDIT) will have a JSON response.
If successful:
{
"success": “true”,
"error":” false”,
"error_message": "data array”,
"data": “{
ID: “ID of changed item”
}”
}
If there is an error:
{
"success": “false”,
"error":” true”,
"error_message": "Error message”,
"Data": “”
}
NOTE: Errors can be caused by server issues or improper requests.
Clients
Get Client List
URL: https://gigabook.com/api/clients/list
Methods: POST
| Parameters | Required/Optional | Description |
| lastname | Optional | (search by %like% or like%
Client last name in ‘string’ if one letter) |
| firstname | Optional | (search by %like% or like%
Client first name in ‘string’ if one letter) |
| deleted | Optional | Deleted or not client ‘enum string’ (0,1) |
| sort_field | Optional | Select information about client in ‘string’ |
| sort | Required | In row descending or ascending in ‘enum string’ (asc, desc) |
Example
Request:
JSON
{
"lastname" : 'Doe',
"firstname" : 'John',
"deleted": "0",
"sort_field": 'string',
"sort": "asc"
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message":"",
"data" : [
[
"ID":"12",
"FirstName":"John",
"LastName":"Doe",
"EmailAdd":"Email@site.com",
"Title" :"Title",
"PrimaryPhone":"55555555",
"AppInterval":"0",
"Rem" :"Rem",
"Notify":"Notify",
"Timezone": "UTC+8",
"CompanyName":"Doe’s corp",
"JobTitle": "CEO",
"ContactNo":"5559888",
"Notes_" :"Notes" ,
"HomeNo": "5554477",
"Country" :"USA" ,
"HomeAddress":"Mountain ave. 33, ap.11",
"UnitNumber":"UnitNumber",
"City" :"Chicago",
"State":"Illinois",
"ZipCode":"54544",
"BirthDate": "12/1/1990",
"Age" :"25",
"Gender":"M",
"Discounts":"2",
"RelatedNames": "Johnny",
"SocialMedia" :"facebook.com/johnnydoe",
"Url" :"site.com",
"WorkPhone":"5545944",
"last_modified":"4/8/2016",
"CreatedBy":"John Doe",
"ModifiedBy":"John Doe"
]
]
}
Get A Client by ID
URL: https://gigabook.com/api/clients/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Client’s ID in ‘string’ |
Request:
ID=157
Response:
JSON
{
"success":"true",
"error":"false",
"error_message":"",
"data" : [
"ID":"157",
"FirstName":"John",
"LastName":"Doe",
"EmailAdd":"Email@site.com",
"Title" :"Title",
"PrimaryPhone":"5554488",
"AppInterval":"0",
"Rem" :"Rem",
"Notify":"Notify",
"Timezone": "UTC+8",
"CompanyName":"Doe’s corp",
"JobTitle": "CEO",
"ContactNo":"5555799",
"Notes_" :"Notes_" ,
"HomeNo": "4558887",
"Country" :"USA",
"HomeAddress":"Mountine ave. 12, ap.10",
"UnitNumber":"UnitNumber",
"City" :"Boston",
"State":"Taxes",
"ZipCode":"47410",
"BirthDate": "8/8/1987",
"Age" :"31",
"Gender":"M",
"Discounts":"3",
"RelatedNames": "Johnny boy",
"SocialMedia" :"twitter.com/johnyboytw",
"Url" :"site.com",
"WorkPhone":"5475677",
"last_modified":"4/4/2016",
"CreatedBy":"John Doe",
"ModifiedBy":"John Doe"
]
}
Add A Client
URL: https://gigabook.com/api/clients/add
Methods: POST
| Parameters | Required/Optional | Description |
| 'FirstName' | Required | Client’s last name in ‘string’ (search by %like% or like% if one letter) |
| 'LastName' | Optional | Client’s first name in ‘string’ (search by %like% or like% if one letter) |
| 'EmailAdd' | Optional | Client’s email address |
| 'PrimaryPhone' | Optional | Client’s office phone in phone type |
| 'WorkPhone' | Optional | Client’s fax number in phone type |
| 'ContactNo' | Optional | Client’s mobile phone number in phone type |
| 'HomeNo' | Optional | Client’s home phone number in phone type |
| 'Country' | Optional | Client’s country |
| 'City' | Optional | Client’s city |
| 'State' | Optional | Client’s state |
| 'HomeAddress' | Optional | Client’s home address |
| 'ZipCode' | Optional | Client’s zipcode |
| 'Timezone' | Optional | Client’s time zone |
| 'CompanyName' | Optional | Client’s company name |
| 'JobTitle' | Optional | Client’s job title |
| 'Url' | Optional | Client’s website url |
| 'SocialMedia' | Optional | Client’s social media links |
| 'Gender' | Optional | Client’s gender in (Important: "M" male, "F" female) |
| 'BirthDate' | Optional | Client’s birth date (date format) |
| 'AppInterval' | Optional | Application interval in enum (0,1) |
| 'Notes_' | Optional | Notes about client |
| 'RelatedNames' | Optional | Related names |
| 'Discounts' | Optional | Client’s discount |
Example
Request:
JSON
{
"FirstName":"Jane",
"LastName":"Doe",
"EmailAdd'':"email@site.com",
"PrimaryPhone":"5558020",
"WorkPhone":"5558028",
"ContactNo":"5558001",
"HomeNo":"5558120",
"Country":"USA '',
"City":"Los Angeles",
"State":"California"',
"HomeAddress": "Sunshine ave 1109'',
"ZipCode":"34341",
"Timezone":"UTC+7",
"CompanyName":"Doe’s company"',
"JobTitle":"CTO"',
"Url': "site.com'',
"SocialMedia":'pinterest.com/janedoe"',
"Gender":"F",
"BirthDate":''02/27/1992",
"AppInterval":"0",
"Notes_":"Notes_",
"RelatedNames":"Sun",
"Discounts":"3"
}
Response:
JSON
{
"success": "true",
"error":" false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Update A Client
URL: https://gigabook.com/api/clients/update
Methods: POST
| Parameters | Required/Optional | Description |
| 'FirstName' | Required | Client’s first name in ‘string’ (search by %like% or like% if one letter) |
| 'LastName' | Optional | Client’s last name in ‘string’ (search by %like% or like% if one letter) |
| 'ID' | Required | Client’s ID in (Integer) |
| 'EmailAdd' | Optional | Client’s email address |
| 'PrimaryPhone' | Optional | Client’s primary phone in phone type |
| 'WorkPhone' | Optional | Client’s work phone number in phone type |
| 'ContactNo' | Optional | Client’s contact phone number in phone type |
| 'HomeNo' | Optional | Client’s home phone number in phone type |
| 'Country' | Optional | Client’s country |
| 'City' | Optional | Client’s city |
| 'State' | Optional | Client’s state |
| 'HomeAddress' | Optional | Client’s home address |
| 'ZipCode' | Optional | Client’s zipcode |
| 'Timezone' | Optional | Client’s time zone |
| 'CompanyName' | Optional | Client’s company name |
| 'JobTitle' | Optional | Client’s job title |
| 'Url' | Optional | Client’s website url |
| 'SocialMedia' | Optional | Client’s social media links |
| 'Gender' | Optional | Client’s gender in (Important: "M" male, "F" female) |
| 'BirthDate' | Optional | Client’s birth date (date format) |
| 'AppInterval' | Optional | Application interval in enum (0,1) |
| 'Notes_' | Optional | Notes about client |
| 'RelatedNames' | Optional | Related names |
| 'Discounts' | Optional | Client’s discount |
Request:
JSON
{
"ID":"32322",
"FirstName":"James",
"LastName":"Doe",
"EmailAdd'':"email@site.com",
"PrimaryPhone":"5548711",
"WorkPhone":"5548712",
"ContactNo":"5548717",
"HomeNo":"5548710",
"Country":"USA '',
"City":"Indianapolis",
"State":"indiana'',
"HomeAddress": "Montana st.122, ap.19'',
"ZipCode":"45457",
"Timezone":"UTC+9",
"CompanyName":"James company"',
"JobTitle":"PM"',
"Url': "site.co,
"SocialMedia":facebook.com/jamesdoe"',
"Gender":"M",
"BirthDate":8/7/1991",
"AppInterval":"0",
"Notes_":"Notes_",
"RelatedNames":"Lebrone",
"Discounts":"5"
}
Response:
JSON
{
"success": "true",
"error":" false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Delete a Client
URL: https://gigabook.com/api/clients/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Client’s ID in ‘string’ |
Example
Request:
"ID": "223"
Response:
JSON
{
"success": "true",
"error":" false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Restore client
URL: https://gigabook.com/api/clients/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Client’s ID |
Example
Request:
"ID": "223"
Response:
JSON
{
"success": "true",
"error":" false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Providers
Get Providers List
URL: https://gigabook.com/api/providers/list
Methods: GET
Example
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "13587",
"view_permission": "Y",
"del_provider": "Y",
"del_service": "Y",
"del_client": "Y",
"FirstName": "Aner",
"LastName": "Ortega",
"EmailAdd": "anortega@fullscale.io",
"HomePhone": "",
"MobilePhone": "",
"ContactNo": "+63(916)267-9683",
"HomeAddress": "",
"UnitNumber": "",
"City": "",
"State": "",
"Zipcode": "",
"BirthDate": "0",
"Gender": "",
"RelatedNames": "",
"Notes_": "",
"MondayIn": "8:00",
"TuesdayIn": "8:00",
"WednesdayIn": "8:00",
"ThursdayIn": "8:00",
"FridayIn": "8:00",
"SaturdayIn": "8:00",
"SundayIn": "8:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"Availability": "Y",
"AvailStart": "0",
"AvailEnd": "0",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "Y",
"sunAvailability": "Y",
"AppointBGColor": "#1ABD9C",
"EventBGColor": "#1ABD9C",
"AppointAltBGColor": "#1ABD9C",
"CarryOverBGColor": "#1ABD9C",
"del_tracker": "Y",
"del_todo": "Y",
"del_groups": "Y",
"view_customforms": "Y",
"del_customforms": "Y",
"upd_customforms": "Y",
"upd_binfo": "Y",
"upd_bpolicy": "Y",
"upd_subsc": "Y",
"upd_emailnotifycont": "Y",
"upd_emailtemplate": "Y",
"upd_emailsettings": "Y",
"upd_provider": "Y",
"dwn_reports": "Y",
"dwn_clientlist": "Y",
"viewdel_clients": "N",
"viewdel_services": "N",
"view_services": "Y",
"upd_services": "Y",
"del_services": "Y",
"view_addons": "Y",
"upd_addons": "Y",
"del_addons": "Y",
"viewdel_addons": "Y",
"view_groups": "Y",
"upd_groups": "Y",
"viewdel_groups": "Y",
"viewdel_customforms": "Y",
"viewdel_invoices": "Y",
"viewdel_promocodes": "Y",
"viewdel_providers": "N",
"viewdel_schedules": "N",
"viewother_providers": "Y",
"viewother_prov_clients": "Y",
"view_confirm": "Y",
"view_clients": "Y",
"upd_clients": "Y",
"view_calendar": "Y",
"view_invoices": "Y",
"upd_invoices": "Y",
"del_invoices": "Y",
"view_todos": "Y",
"view_projects": "Y",
"view_promocodes": "Y",
"view_dashboard": "Y",
"view_history": "Y",
"upd_calendar": "Y",
"del_schedules": "Y",
"upd_settings": "Y",
"upd_paysettings": "Y",
"upd_gigasync": "Y",
"upd_apisettings": "Y",
"upd_widgets": "Y",
"upd_promocodes": "Y",
"del_promocodes": "Y",
"last_modified": "2018-09-10 19:09:07",
"deleted": "0",
"OfficePhone": null,
"Country": "",
"Bio": null,
"Timezone": "America/New_York",
"OptOutEmail": null,
"MainImage": null,
"ShowContactNo": "0",
"ShowEmail": "0",
"ShowOfficePhone": "1",
"ShowLastName": "1",
"Hide": "0"
}
]
}
Get A Provider by ID
URL: https://gigabook.com/api/providers/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Provider’s ID in ‘string’ |
Request:
ID=13587
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "13587",
"view_permission": "Y",
"del_provider": "Y",
"del_service": "Y",
"del_client": "Y",
"FirstName": "Aner",
"LastName": "Ortega",
"EmailAdd": "anortega@fullscale.io",
"HomePhone": "",
"MobilePhone": "",
"ContactNo": "+63(916)267-9683",
"HomeAddress": "",
"UnitNumber": "",
"City": "",
"State": "",
"Zipcode": "",
"BirthDate": "0",
"Gender": "",
"RelatedNames": "",
"Notes_": "",
"MondayIn": "8:00",
"TuesdayIn": "8:00",
"WednesdayIn": "8:00",
"ThursdayIn": "8:00",
"FridayIn": "8:00",
"SaturdayIn": "8:00",
"SundayIn": "8:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"Availability": "Y",
"AvailStart": "0",
"AvailEnd": "0",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "Y",
"sunAvailability": "Y",
"AppointBGColor": "#1ABD9C",
"EventBGColor": "#1ABD9C",
"AppointAltBGColor": "#1ABD9C",
"CarryOverBGColor": "#1ABD9C",
"del_tracker": "Y",
"del_todo": "Y",
"del_groups": "Y",
"view_customforms": "Y",
"del_customforms": "Y",
"upd_customforms": "Y",
"upd_binfo": "Y",
"upd_bpolicy": "Y",
"upd_subsc": "Y",
"upd_emailnotifycont": "Y",
"upd_emailtemplate": "Y",
"upd_emailsettings": "Y",
"upd_provider": "Y",
"dwn_reports": "Y",
"dwn_clientlist": "Y",
"viewdel_clients": "N",
"viewdel_services": "N",
"view_services": "Y",
"upd_services": "Y",
"del_services": "Y",
"view_addons": "Y",
"upd_addons": "Y",
"del_addons": "Y",
"viewdel_addons": "Y",
"view_groups": "Y",
"upd_groups": "Y",
"viewdel_groups": "Y",
"viewdel_customforms": "Y",
"viewdel_invoices": "Y",
"viewdel_promocodes": "Y",
"viewdel_providers": "N",
"viewdel_schedules": "N",
"viewother_providers": "Y",
"viewother_prov_clients": "Y",
"view_confirm": "Y",
"view_clients": "Y",
"upd_clients": "Y",
"view_calendar": "Y",
"view_invoices": "Y",
"upd_invoices": "Y",
"del_invoices": "Y",
"view_todos": "Y",
"view_projects": "Y",
"view_promocodes": "Y",
"view_dashboard": "Y",
"view_history": "Y",
"upd_calendar": "Y",
"del_schedules": "Y",
"upd_settings": "Y",
"upd_paysettings": "Y",
"upd_gigasync": "Y",
"upd_apisettings": "Y",
"upd_widgets": "Y",
"upd_promocodes": "Y",
"del_promocodes": "Y",
"last_modified": "2018-09-10 19:09:07",
"deleted": "0",
"OfficePhone": null,
"Country": "",
"Bio": null,
"Timezone": "America/New_York",
"OptOutEmail": null,
"MainImage": null,
"ShowContactNo": "0",
"ShowEmail": "0",
"ShowOfficePhone": "1",
"ShowLastName": "1",
"Hide": "0"
}
}
Add A Provider
URL: https://gigabook.com/api/providers/add
Methods: POST
| Parameters | Required/Optional | Description |
| 'FirstName' | Required | Provider’s first name in ‘string’ (search by %like% or like% if one letter) |
| 'LastName' | Optional | Provider’s last name in ‘string’ (search by %like% or like% if one letter) |
| 'Services' | Optional | Array of Service IDs |
| 'ImageData' | Optional | Base64 Encoded Image |
Example
Request:
JSON
{
"FirstName": "Clea",
"LastName": "Sebastian"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": 13590
}
}
Update A Provider
URL: https://gigabook.com/api/providers/update
Methods: POST
| Parameters | Required/Optional | Description |
| 'FirstName' | Required | Provider’s first name in ‘string’ (search by %like% or like% if one letter) |
| 'LastName' | Optional | Provider’s last name in ‘string’ (search by %like% or like% if one letter) |
| 'ID' | Required | Provider’s ID in (Integer) |
| 'EmailAdd' | Optional | Provider’s email address |
| 'HomePhone' | Optional | Provider’s primary phone in phone type |
| 'MobilePhone' | Optional | Provider’s mobile phone number in phone type |
| 'ContactNo' | Optional | Provider’s contact phone number in phone type |
| 'HomeNo' | Optional | Client’s home phone number in phone type |
| 'Remove_Image' | Optional | YN |
| 'ImageData' | Optional | Base64 Encoded Image |
Request:
JSON
{
"ID": "13590",
"FirstName": "Clea Monique",
"LastName": "Ortega",
"EmailAdd": "clea@google.com"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "13590"
}
}
Delete a Provider
URL: https://gigabook.com/api/providers/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Provider’s ID in ‘string’ |
Example
Request:
"ID": "13587"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "13587"
}
}
Restore Provider
URL: https://gigabook.com/api/providers/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Provider’s ID |
Example
Request:
"ID": "13587"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "13587"
}
}
Resources
Get Resources List
URL: https://gigabook.com/api/resources/list
Methods: GET
Example
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "13593",
"view_permission": "Y",
"del_provider": "Y",
"del_service": "Y",
"del_client": "Y",
"FirstName": "Test Resources",
"LastName": "",
"EmailAdd": "anortega@fullscale.io",
"HomePhone": "",
"MobilePhone": "",
"ContactNo": "(639)162-6796",
"HomeAddress": "",
"UnitNumber": "",
"City": "",
"State": "",
"Zipcode": "",
"BirthDate": "0",
"Gender": "",
"RelatedNames": "",
"Notes_": "nothing to note",
"MondayIn": "8:00",
"TuesdayIn": "8:00",
"WednesdayIn": "8:00",
"ThursdayIn": "8:00",
"FridayIn": "8:00",
"SaturdayIn": "",
"SundayIn": "",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "",
"SundayOut": "",
"Availability": "Y",
"AvailStart": "0",
"AvailEnd": "0",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "N",
"sunAvailability": "N",
"AppointBGColor": "#d5a6bd",
"EventBGColor": "#d5a6bd",
"AppointAltBGColor": "#1ABD9C",
"CarryOverBGColor": "#d5a6bd",
"del_tracker": "Y",
"del_todo": "Y",
"del_groups": "Y",
"view_customforms": "Y",
"del_customforms": "Y",
"upd_customforms": "Y",
"upd_binfo": "Y",
"upd_bpolicy": "Y",
"upd_subsc": "Y",
"upd_emailnotifycont": "Y",
"upd_emailtemplate": "Y",
"upd_emailsettings": "Y",
"upd_provider": "Y",
"dwn_reports": "Y",
"dwn_clientlist": "Y",
"viewdel_clients": "N",
"viewdel_services": "N",
"view_services": "Y",
"upd_services": "Y",
"del_services": "Y",
"view_addons": "Y",
"upd_addons": "Y",
"del_addons": "Y",
"viewdel_addons": "Y",
"view_groups": "Y",
"upd_groups": "Y",
"viewdel_groups": "Y",
"viewdel_customforms": "Y",
"viewdel_invoices": "Y",
"viewdel_promocodes": "Y",
"viewdel_providers": "N",
"viewdel_schedules": "N",
"viewother_providers": "Y",
"viewother_prov_clients": "Y",
"view_confirm": "Y",
"view_clients": "Y",
"upd_clients": "Y",
"view_calendar": "Y",
"view_invoices": "Y",
"upd_invoices": "Y",
"del_invoices": "Y",
"view_todos": "Y",
"view_projects": "Y",
"view_promocodes": "Y",
"view_dashboard": "Y",
"view_history": "Y",
"upd_calendar": "Y",
"del_schedules": "Y",
"upd_settings": "Y",
"upd_paysettings": "Y",
"upd_gigasync": "Y",
"upd_apisettings": "Y",
"upd_widgets": "Y",
"upd_promocodes": "Y",
"del_promocodes": "Y",
"last_modified": "2018-10-01 18:32:08",
"OfficePhone": "",
"Country": "",
"Bio": "< div>adadfsadfasdfasdf< br >< /div>",
"Timezone": "",
"OptOutEmail": null,
"MainImage": "",
"ShowContactNo": "0",
"ShowEmail": "0",
"ShowOfficePhone": "0",
"ShowLastName": "0",
"Hide": "0"
},
{
"ID": "13594",
"view_permission": "Y",
"del_provider": "Y",
"del_service": "Y",
"del_client": "Y",
"FirstName": "Another Resources",
"LastName": "",
"EmailAdd": "",
"HomePhone": "",
"MobilePhone": "",
"ContactNo": "",
"HomeAddress": "",
"UnitNumber": "",
"City": "",
"State": "",
"Zipcode": "",
"BirthDate": "0",
"Gender": "",
"RelatedNames": "",
"Notes_": "",
"MondayIn": "8:00",
"TuesdayIn": "8:00",
"WednesdayIn": "8:00",
"ThursdayIn": "8:00",
"FridayIn": "8:00",
"SaturdayIn": "",
"SundayIn": "",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "",
"SundayOut": "",
"Availability": "Y",
"AvailStart": "0",
"AvailEnd": "0",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "N",
"sunAvailability": "N",
"AppointBGColor": "#76a5af",
"EventBGColor": "#76a5af",
"AppointAltBGColor": "#1ABD9C",
"CarryOverBGColor": "#76a5af",
"del_tracker": "Y",
"del_todo": "Y",
"del_groups": "Y",
"view_customforms": "Y",
"del_customforms": "Y",
"upd_customforms": "Y",
"upd_binfo": "Y",
"upd_bpolicy": "Y",
"upd_subsc": "Y",
"upd_emailnotifycont": "Y",
"upd_emailtemplate": "Y",
"upd_emailsettings": "Y",
"upd_provider": "Y",
"dwn_reports": "Y",
"dwn_clientlist": "Y",
"viewdel_clients": "N",
"viewdel_services": "N",
"view_services": "Y",
"upd_services": "Y",
"del_services": "Y",
"view_addons": "Y",
"upd_addons": "Y",
"del_addons": "Y",
"viewdel_addons": "Y",
"view_groups": "Y",
"upd_groups": "Y",
"viewdel_groups": "Y",
"viewdel_customforms": "Y",
"viewdel_invoices": "Y",
"viewdel_promocodes": "Y",
"viewdel_providers": "N",
"viewdel_schedules": "N",
"viewother_providers": "Y",
"viewother_prov_clients": "Y",
"view_confirm": "Y",
"view_clients": "Y",
"upd_clients": "Y",
"view_calendar": "Y",
"view_invoices": "Y",
"upd_invoices": "Y",
"del_invoices": "Y",
"view_todos": "Y",
"view_projects": "Y",
"view_promocodes": "Y",
"view_dashboard": "Y",
"view_history": "Y",
"upd_calendar": "Y",
"del_schedules": "Y",
"upd_settings": "Y",
"upd_paysettings": "Y",
"upd_gigasync": "Y",
"upd_apisettings": "Y",
"upd_widgets": "Y",
"upd_promocodes": "Y",
"del_promocodes": "Y",
"last_modified": "2018-10-01 19:06:01",
"OfficePhone": "",
"Country": "",
"Bio": "",
"Timezone": "",
"OptOutEmail": null,
"MainImage": "Another_Resources.png",
"ShowContactNo": "0",
"ShowEmail": "0",
"ShowOfficePhone": "0",
"ShowLastName": "0",
"Hide": "0"
}
]
}
Get A Resources by ID
URL: https://gigabook.com/api/resources/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Resources’ ID in ‘string’ |
Request:
ID=13593
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "13593",
"view_permission": "Y",
"del_provider": "Y",
"del_service": "Y",
"del_client": "Y",
"FirstName": "Test Resources",
"LastName": "",
"EmailAdd": "anortega@fullscale.io",
"HomePhone": "",
"MobilePhone": "",
"ContactNo": "(639)162-6796",
"HomeAddress": "",
"UnitNumber": "",
"City": "",
"State": "",
"Zipcode": "",
"BirthDate": "0",
"Gender": "",
"RelatedNames": "",
"Notes_": "nothing to note",
"MondayIn": "8:00",
"TuesdayIn": "8:00",
"WednesdayIn": "8:00",
"ThursdayIn": "8:00",
"FridayIn": "8:00",
"SaturdayIn": "",
"SundayIn": "",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "",
"SundayOut": "",
"Availability": "Y",
"AvailStart": "0",
"AvailEnd": "0",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "N",
"sunAvailability": "N",
"AppointBGColor": "#d5a6bd",
"EventBGColor": "#d5a6bd",
"AppointAltBGColor": "#1ABD9C",
"CarryOverBGColor": "#d5a6bd",
"del_tracker": "Y",
"del_todo": "Y",
"del_groups": "Y",
"view_customforms": "Y",
"del_customforms": "Y",
"upd_customforms": "Y",
"upd_binfo": "Y",
"upd_bpolicy": "Y",
"upd_subsc": "Y",
"upd_emailnotifycont": "Y",
"upd_emailtemplate": "Y",
"upd_emailsettings": "Y",
"upd_provider": "Y",
"dwn_reports": "Y",
"dwn_clientlist": "Y",
"viewdel_clients": "N",
"viewdel_services": "N",
"view_services": "Y",
"upd_services": "Y",
"del_services": "Y",
"view_addons": "Y",
"upd_addons": "Y",
"del_addons": "Y",
"viewdel_addons": "Y",
"view_groups": "Y",
"upd_groups": "Y",
"viewdel_groups": "Y",
"viewdel_customforms": "Y",
"viewdel_invoices": "Y",
"viewdel_promocodes": "Y",
"viewdel_providers": "N",
"viewdel_schedules": "N",
"viewother_providers": "Y",
"viewother_prov_clients": "Y",
"view_confirm": "Y",
"view_clients": "Y",
"upd_clients": "Y",
"view_calendar": "Y",
"view_invoices": "Y",
"upd_invoices": "Y",
"del_invoices": "Y",
"view_todos": "Y",
"view_projects": "Y",
"view_promocodes": "Y",
"view_dashboard": "Y",
"view_history": "Y",
"upd_calendar": "Y",
"del_schedules": "Y",
"upd_settings": "Y",
"upd_paysettings": "Y",
"upd_gigasync": "Y",
"upd_apisettings": "Y",
"upd_widgets": "Y",
"upd_promocodes": "Y",
"del_promocodes": "Y",
"last_modified": "2018-10-01 18:32:08",
"deleted": "0",
"OfficePhone": "",
"Country": "",
"Bio": "< div>adadfsadfasdfasdf< br >< /div>",
"Timezone": "",
"OptOutEmail": null,
"MainImage": "",
"ShowContactNo": "0",
"ShowEmail": "0",
"ShowOfficePhone": "0",
"ShowLastName": "0",
"Hide": "0"
}
}
Add A Resources
URL: https://gigabook.com/api/resources/add
Methods: POST
| Parameters | Required/Optional | Description |
| ResourcesName | Required | Resources' name in ‘string’ (search by %like% or like% if one letter) |
| EmailAdd | Optional | Email address in ‘string’ |
| ContactNo | Optional | String in phone type |
| Services | Optional | Array of Service IDs |
| ImageData | Optional | Base64 Encoded Image |
Example
Request:
JSON
{
"ResourcesName": "API Resources",
"EmailAdd": "atortega1@yahoo.com",
"ContactNo": "639162679863"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "13599",
"view_permission": "Y",
"del_provider": "Y",
"del_service": "Y",
"del_client": "Y",
"FirstName": "API Resources",
"LastName": "",
"EmailAdd": "atortega1@yahoo.com",
"HomePhone": "",
"MobilePhone": "",
"ContactNo": "639162679863",
"HomeAddress": "",
"UnitNumber": "",
"City": "",
"State": "",
"Zipcode": "",
"BirthDate": "0",
"Gender": "",
"RelatedNames": "",
"Notes_": "",
"MondayIn": "8:00",
"TuesdayIn": "8:00",
"WednesdayIn": "8:00",
"ThursdayIn": "8:00",
"FridayIn": "8:00",
"SaturdayIn": "8:00",
"SundayIn": "8:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"Availability": "Y",
"AvailStart": "0",
"AvailEnd": "0",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "Y",
"sunAvailability": "Y",
"AppointBGColor": " #1ABD9C",
"EventBGColor": "#1ABD9C",
"AppointAltBGColor": "#1ABD9C",
"CarryOverBGColor": "#1ABD9C",
"del_tracker": "Y",
"del_todo": "Y",
"del_groups": "Y",
"view_customforms": "Y",
"del_customforms": "Y",
"upd_customforms": "Y",
"upd_binfo": "Y",
"upd_bpolicy": "Y",
"upd_subsc": "Y",
"upd_emailnotifycont": "Y",
"upd_emailtemplate": "Y",
"upd_emailsettings": "Y",
"upd_provider": "Y",
"dwn_reports": "Y",
"dwn_clientlist": "Y",
"viewdel_clients": "N",
"viewdel_services": "N",
"view_services": "Y",
"upd_services": "Y",
"del_services": "Y",
"view_addons": "Y",
"upd_addons": "Y",
"del_addons": "Y",
"viewdel_addons": "Y",
"view_groups": "Y",
"upd_groups": "Y",
"viewdel_groups": "Y",
"viewdel_customforms": "Y",
"viewdel_invoices": "Y",
"viewdel_promocodes": "Y",
"viewdel_providers": "N",
"viewdel_schedules": "N",
"viewother_providers": "Y",
"viewother_prov_clients": "Y",
"view_confirm": "Y",
"view_clients": "Y",
"upd_clients": "Y",
"view_calendar": "Y",
"view_invoices": "Y",
"upd_invoices": "Y",
"del_invoices": "Y",
"view_todos": "Y",
"view_projects": "Y",
"view_promocodes": "Y",
"view_dashboard": "Y",
"view_history": "Y",
"upd_calendar": "Y",
"del_schedules": "Y",
"upd_settings": "Y",
"upd_paysettings": "Y",
"upd_gigasync": "Y",
"upd_apisettings": "Y",
"upd_widgets": "Y",
"upd_promocodes": "Y",
"del_promocodes": "Y",
"last_modified": "2018-10-03 08:25:52",
"deleted": "0",
"OfficePhone": null,
"Country": null,
"Bio": null,
"Timezone": "",
"OptOutEmail": null,
"MainImage": null,
"ShowContactNo": "0",
"ShowEmail": "0",
"ShowOfficePhone": "1",
"ShowLastName": "1",
"Hide": "0"
}
}
Update A Resources
URL: https://gigabook.com/api/resources/update
Methods: POST
| Parameters | Required/Optional | Description |
| ResourcesName | Required | Resources name in ‘string’ |
| ID | Required | Resources’ ID in (Integer) |
| EmailAdd | Optional | Email address in ‘string’ |
| ContactNo | Optional | String in phone type |
| Services | Optional | Array of Service IDs |
| ImageData | Optional | Base64 Encoded Image |
Request:
JSON
{
"ID": "13598",
"ResourcesName": "Updated API Resources"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "13598",
"view_permission": "Y",
"del_provider": "Y",
"del_service": "Y",
"del_client": "Y",
"FirstName": "Updated API Resources",
"LastName": "",
"EmailAdd": "",
"HomePhone": "",
"MobilePhone": "",
"ContactNo": "",
"HomeAddress": "",
"UnitNumber": "",
"City": "",
"State": "",
"Zipcode": "",
"BirthDate": "0",
"Gender": "",
"RelatedNames": "",
"Notes_": "",
"MondayIn": "8:00",
"TuesdayIn": "8:00",
"WednesdayIn": "8:00",
"ThursdayIn": "8:00",
"FridayIn": "8:00",
"SaturdayIn": "8:00",
"SundayIn": "8:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"Availability": "Y",
"AvailStart": "0",
"AvailEnd": "0",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "Y",
"sunAvailability": "Y",
"AppointBGColor": " #1ABD9C",
"EventBGColor": "#1ABD9C",
"AppointAltBGColor": "#1ABD9C",
"CarryOverBGColor": "#1ABD9C",
"del_tracker": "Y",
"del_todo": "Y",
"del_groups": "Y",
"view_customforms": "Y",
"del_customforms": "Y",
"upd_customforms": "Y",
"upd_binfo": "Y",
"upd_bpolicy": "Y",
"upd_subsc": "Y",
"upd_emailnotifycont": "Y",
"upd_emailtemplate": "Y",
"upd_emailsettings": "Y",
"upd_provider": "Y",
"dwn_reports": "Y",
"dwn_clientlist": "Y",
"viewdel_clients": "N",
"viewdel_services": "N",
"view_services": "Y",
"upd_services": "Y",
"del_services": "Y",
"view_addons": "Y",
"upd_addons": "Y",
"del_addons": "Y",
"viewdel_addons": "Y",
"view_groups": "Y",
"upd_groups": "Y",
"viewdel_groups": "Y",
"viewdel_customforms": "Y",
"viewdel_invoices": "Y",
"viewdel_promocodes": "Y",
"viewdel_providers": "N",
"viewdel_schedules": "N",
"viewother_providers": "Y",
"viewother_prov_clients": "Y",
"view_confirm": "Y",
"view_clients": "Y",
"upd_clients": "Y",
"view_calendar": "Y",
"view_invoices": "Y",
"upd_invoices": "Y",
"del_invoices": "Y",
"view_todos": "Y",
"view_projects": "Y",
"view_promocodes": "Y",
"view_dashboard": "Y",
"view_history": "Y",
"upd_calendar": "Y",
"del_schedules": "Y",
"upd_settings": "Y",
"upd_paysettings": "Y",
"upd_gigasync": "Y",
"upd_apisettings": "Y",
"upd_widgets": "Y",
"upd_promocodes": "Y",
"del_promocodes": "Y",
"last_modified": "2018-10-02 18:34:30",
"deleted": "0",
"OfficePhone": null,
"Country": null,
"Bio": null,
"Timezone": "",
"OptOutEmail": null,
"MainImage": null,
"ShowContactNo": "0",
"ShowEmail": "0",
"ShowOfficePhone": "1",
"ShowLastName": "1",
"Hide": "0"
}
}
Delete a Resources
URL: https://gigabook.com/api/resources/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Resources’ ID in ‘string’ |
Example
Request:
"ID": "13593"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "13593"
}
}
Restore Resources
URL: https://gigabook.com/api/resources/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Resources’ ID |
Example
Request:
JSON
{
"ID": "13593"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "13593"
}
}
Schedule
Schedule Types:
APP Appointment
EVE Event
BLK Block Schedule
TOD To Do
GRO Group Event
Get Schedule List
URL: https://gigabook.com/api/schedules/list
Methods: POST
| Parameters | Required/Optional | Description |
| clientname | Optional | Client’s name |
| schedtype | Optional | Type of schedule |
| description | Optional | Schedule’s list description |
| notes | Optional | Schedule’s list notes |
| notesinternal | Optional | In ‘string’ |
| startdt | Optional | Event start |
| enddt | Optional | Event end |
| deleted | Optional | Deleted or not client ‘enum string’ (0,1) |
| sort_field | Optional | Select information about client in ‘string’. |
| sort | Required | In row descending or ascending in ‘enum string’ (asc, desc). |
| ID | Optional | Schedules ID |
Request:
"ID":"2323"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
[
"ID": "6",
"AccountEmailAdd": "test2@test.com",
"AcctLnkID": "4",
"SerInfoLnkID": "2",
"SchedType": "APP",
"Description": "test1",
"ClientEmail": "",
"ClientName": "Data112",
"StartDT": "20160818",
"EndDT": "20160818",
"StartTime": "12:00",
"EndTime": "13:00",
"Provider": "test test",
"ProvLnkID": "7",
"Notes": "",
"NotesInternal": "",
"SourceGCalID": "",
"Rem": "",
"Dt": "20160818 03:59:12",
"TotMins": "60",
"TotHrs": "1.00",
"Creator": "user",
"status": "Created",
"reason": "",
"code": "eR3DUvlxpJ",
"GcalID": "",
"GcalID_Imp": "",
"iCAL_UID": "",
"OutlookID": "",
"ToDoLnkID": "0",
"ToDoLnkID_Prev": null,
"forsort": "0",
"prevforsort": "0",
"prevstarsort": "0",
"star": "",
"starsort": "0",
"drag_": "",
"prevpos": "0",
"WithDue": "",
"WithTime": "",
"RemWithTime": "",
"Dueonoff": "off",
"Remonoff": "off",
"AllSort": "1471536000",
"MultiC": "Y",
"Rec_EventYN": "N",
"Rec_Lnk": "",
"CODayCtr": "0",
"CODtTmStart": "00000000 00:00:00",
"CODtTmEnd": "00000000 00:00:00",
"COTotHrs": "0.00",
"COTotMins": "0",
"last_modified": "20160818 04:59:00",
"last_modifier": "0",
"deleted": "0",
"Completion": "Y",
"ClientRem1": "00000000 00:00:00",
"ClientRem2": "00000000 00:00:00",
"ClientRem3": "00000000 00:00:00",
"ProvRem1": "00000000 00:00:00",
"ProvRem2": "00000000 00:00:00",
"ProvRem3": "00000000 00:00:00",
"TxtClientRem1": "00000000 00:00:00",
"TxtClientRem2": "00000000 00:00:00",
"TxtClientRem3": "00000000 00:00:00",
"TxtProvRem1": "00000000 00:00:00",
"TxtProvRem2": "00000000 00:00:00",
"TxtProvRem3": "00000000 00:00:00",
"MulEAType": "",
"RepeatDayWeek": "day",
"UserLogged": "4",
"ProvLogged": "0",
"GroupInfoLnkID": "0",
"MinAttendees": "0",
"MaxAttendees": "0",
"ActualCount": "0",
"ClientRem1S": "",
"ClientRem2S": "",
"ClientRem3S": "",
"ProvRem1S": "",
"ProvRem2S": "",
"ProvRem3S": "",
"TxtClientRem1S": "",
"TxtClientRem2S": "",
"TxtClientRem3S": "",
"TxtProvRem1S": "",
"TxtProvRem2S": "",
"TxtProvRem3S": "",
"DueRemS": "",
"DT_Synched": null,
"PrepTime": "0",
"FinishTime": "0",
"Interval_": "0",
"InvoiceID": null,
"NumAttending": "1"
]
]
}
Get Schedule
URL: https://gigabook.com/api/schedules/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Schedules ID |
Request:
"ID"="23424"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
[
"ID": "6",
"AccountEmailAdd": "test2@test.com",
"AcctLnkID": "4",
"SerInfoLnkID": "2",
"SchedType": "APP",
"Description": "test1",
"ClientEmail": "",
"ClientName": "Data112 ",
"StartDT": "20160818",
"EndDT": "20160818",
"StartTime": "12:00",
"EndTime": "13:00",
"Provider": "test test",
"ProvLnkID": "7",
"Notes": "",
"NotesInternal": "",
"SourceGCalID": "",
"Rem": "",
"Dt": "20160818 03:59:12",
"TotMins": "60",
"TotHrs": "1.00",
"Creator": "user",
"status": "Created",
"reason": "",
"code": "eR3DUvlxpJ",
"GcalID": "",
"GcalID_Imp": "",
"iCAL_UID": "",
"OutlookID": "",
"ToDoLnkID": "0",
"ToDoLnkID_Prev": null,
"forsort": "0",
"prevforsort": "0",
"prevstarsort": "0",
"star": "",
"starsort": "0",
"drag_": "",
"prevpos": "0",
"WithDue": "",
"WithTime": "",
"RemWithTime": "",
"Dueonoff": "off",
"Remonoff": "off",
"AllSort": "1471536000",
"MultiC": "Y",
"Rec_EventYN": "N",
"Rec_Lnk": "",
"CODayCtr": "0",
"CODtTmStart": "00000000 00:00:00",
"CODtTmEnd": "00000000 00:00:00",
"COTotHrs": "0.00",
"COTotMins": "0",
"last_modified": "20160818 04:59:00",
"last_modifier": "0",
"deleted": "0",
"Completion": "Y",
"ClientRem1": "00000000 00:00:00",
"ClientRem2": "00000000 00:00:00",
"ClientRem3": "00000000 00:00:00",
"ProvRem1": "00000000 00:00:00",
"ProvRem2": "00000000 00:00:00",
"ProvRem3": "00000000 00:00:00",
"TxtClientRem1": "00000000 00:00:00",
"TxtClientRem2": "00000000 00:00:00",
"TxtClientRem3": "00000000 00:00:00",
"TxtProvRem1": "00000000 00:00:00",
"TxtProvRem2": "00000000 00:00:00",
"TxtProvRem3": "00000000 00:00:00",
"MulEAType": "",
"RepeatDayWeek": "day",
"UserLogged": "4",
"ProvLogged": "0",
"GroupInfoLnkID": "0",
"MinAttendees": "0",
"MaxAttendees": "0",
"ActualCount": "0",
"ClientRem1S": "",
"ClientRem2S": "",
"ClientRem3S": "",
"ProvRem1S": "",
"ProvRem2S": "",
"ProvRem3S": "",
"TxtClientRem1S": "",
"TxtClientRem2S": "",
"TxtClientRem3S": "",
"TxtProvRem1S": "",
"TxtProvRem2S": "",
"TxtProvRem3S": "",
"DueRemS": "",
"DT_Synched": null,
"PrepTime": "0",
"FinishTime": "0",
"Interval_": "0",
"InvoiceID": null,
"NumAttending": "1"
]
]
}
Add A Schedule
All schedules manipulations separated by type of event and list consist of:
APP Appointment
EVE Event
BLK Block schedule
TOD To do
GRO Group event
Parameters for all “Add” requests
Here is table of parameters that you can add to request. Required parameters will have mentioned near of each request.
| Parameters | Description |
| "clientlist" | clients, firstname+secondname OR client id, divided by comma |
| services | attached service id (only one) |
| groups | attached groups (only one group) |
| event | event title |
| notes | public notes, without html tags |
| notesInternal | private (staff) notes, with html tags |
| ProvLnkID | Provider’s (staff member) ID with default empty, list of provider id’s attached. |
| Recurring_EventYN | Recurring events with default "N", "Y" if repeating event recurr_nodays_id=7 repeat event each X days or weeks (depends on RepeatDayWeek value) recur_end=10/19/2016 12:00 PM repeat end date |
| duration | Enter the time it takes the assigned adviser to complete this service. This time will be marked as not available when this service is booked." in minutes, default 60 (or defined by service) |
| PrepTime | Enter the time it takes the assigned adviser to prepare before this service occurs. This time will be marked as not available when this service is booked." in minutes |
| FinishTime | Enter the time it takes the assigned adviser to finish up after this service occurs. This time will be marked as not available when this service is booked." in minutes, default 0 |
| NotiClientTextNow | text notify client when event created, default "N", can be "N" or "Y" (Text Client Now) |
| NotiClientEmailNow | email notify client when event created, default "N", can be "N" or "Y" (Email Client Now) |
| NotiProvEmailNow | text notify provider when event created, default "N", can be "N" or "Y" (Email Staff Member Now) |
| NotiProvTextNow | email notify client when event created, default "N", can be "N" or "Y" (Text Staff Member Now) |
| RemClient_ID1 | remind client before event, value in seconds, default 0 Email Client |
| RemClient_ID2 | remind client before event, value in seconds, default 0 Email Client |
| RemClient_ID3 | remind client before event, value in seconds, default 0 Email Client |
| RemProv_ID1 | remind client before event, value in seconds, default 0 Email Staff Member |
| RemProv_ID2 | remind client before event, value in seconds, default 0 Email Staff Member |
| RemProv_ID3 | remind client before event, value in seconds, default 0 Email Staff Member |
| TxtRemClient_ID1 | text remind client before event, value in seconds, default 0 Text Client |
| TxtRemClient_ID2 | text remind client before event, value in seconds, default 0 Text Client |
| TxtRemProv_ID1 | text remind client before event, value in seconds, default 0 Text Staff Member |
| TxtRemProv_ID2 | text remind client before event, value in seconds, default 0 Text Staff Member |
| StartDtCheck | Date and Time of event, format like 8/29/2016 12:00 PM |
| Override | override conflicts, defalut "NO", can be "NO" or "YES" |
| RepeatDayWeek | default empty, doing nothing when Recurring_EventYN=N, can be "day", "week" |
Add An Appointment
URL: https://gigabook.com/api/schedules/add/app
Methods: POST
| Parameters | Required/Optional | Description |
| "clientlist" | Required | clients, firstname+secondname OR client id, divided by comma |
| "services" | Required | attached service id (only one) |
| duration | Required | Enter the time it takes the assigned adviser to complete this service. This time will be marked as not available when this service is booked." in minutes, default 60 |
| PrepTime | Optional | Enter the time it takes the assigned adviser to prepare before this service occurs. This time will be marked as not available when this service is booked." in minutes |
| FinishTime | Optional | Enter the time it takes the assigned adviser to finish up after this service occurs. This time will be marked as not available when this service is booked." in minutes, default 0 |
| "StartDtCheck" | Required | Date and Time of event, format like 8/29/2016 12:00 PM |
Example
Request:
JSON
{
"clientlist": "Crew of craft",
"services": "1",
"duration": "63",
"StartDtCheck": "8/29/2016 11:00 AM"
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Add An Event
URL: https://gigabook.com/api/schedules/add/eve
Methods: POST
| Parameters | Required/Optional | Description |
| event | Required | Event’s title |
| duration | Required | Enter the time it takes the assigned adviser to complete this service. This time will be marked as not available when this service is booked." in minutes, default 60 |
| PrepTime | Optional | Enter the time it takes the assigned adviser to prepare before this service occurs. This time will be marked as not available when this service is booked." in minutes |
| FinishTime | Optional | Enter the time it takes the assigned adviser to finish up after this service occurs. This time will be marked as not available when this service is booked." in minutes, default 0 |
| "StartDtCheck" | Required | Date and Time of event, format like 8/29/2016 12:00 PM |
Example
Request:
JSON
{
"services": "3",
"event": "Event title iowa",
"duration": "60",
"StartDtCheck": "8/25/2016 12:00 PM"
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed event"
]
}
Add A Block Schedule
URL: https://gigabook.com/api/schedules/add/blk
Methods: POST
| Parameters | Required/Optional | Description |
| duration | Required | Enter the time it takes the assigned adviser to complete this service. This time will be marked as not available when this service is booked." in minutes, default 60 |
| BlockDesc | Required | Title (Description) of block schedules |
| StartDtCheck | Required | Date and Time of event, format like 8/29/2016 12:00 PM |
Example
Request:
JSON
{
"duration": "60",
“BlockDesc”:””,
"StartDtCheck": "8/25/2016 12:00 PM"
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed appointment"
]
}
Add A To Do
URL: https://gigabook.com/api/schedules/add/tod
Methods: POST
| Parameters | Required/Optional | Description |
| "AddItem" | Required | Title of To Do |
| "notes" | Required | Notes of To Do |
| "duedtid" | Required | Date of To Do |
| "remdtid" | Required | Date of reminder |
| "duetimeid" | Required | Time of To Do |
| "remtimeid" | Required | Time of reminder |
Request:
JSON
{
"AddItem": "Todo item 555",
"notes": "",
"duedtid": "8/30/2016",
"remdtid": "8/30/2016",
"duetimeid": "11:35 AM",
"remtimeid": "10:40 AM"
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed To Do item"
]
}
Add A Group Event
URL: https://gigabook.com/api/schedules/add/gro
Methods: POST
| Parameters | Required/Optional | Description |
| "clientlist" | Required | Clients, firstname+secondname OR client id, divided by comma |
| "groups" | Required | ID of event group |
| duration | Required | Enter the time it takes the assigned adviser to complete this service. This time will be marked as not available when this service is booked." in minutes, default 60 |
| PrepTime | Optional | Enter the time it takes the assigned adviser to prepare before this service occurs. This time will be marked as not available when this service is booked." in minutes |
| FinishTime | Optional | Enter the time it takes the assigned adviser to finish up after this service occurs. This time will be marked as not available when this service is booked." in minutes, default 0 |
| "StartDtCheck" | Required | Date and Time of event, format like 8/29/2016 12:00 PM |
Request:
JSON
{
"clientlist": "133,134,First Client",
"services": "1",
"groups": "1",
"duration": "60",
"StartDtCheck": "8/31/2016 1:00 PM"
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed appointment"
]
}
Update A Schedule
URL: https://gigabook.com/api/schedules/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Schedule’s ID |
| description | Optional | Schedule’s description |
| clientemail | Optional | Client’s email |
| clientname | Optional | Client’s name |
| startdt | Optional | Event start (date) |
| enddt | Optional | Event end (date) |
| starttime | Optional | Event start (time) |
| endtime | Optional | Event end (time) |
| notes | Optional | Schedule’s notes |
| notesinternal | Optional | Notes for stuff |
| dt | Optional | Time stamp of schedule event creation |
| deleted | Optional | Deleted or not(0,1) |
| clientrem1 | Optional | remind client before event, value in seconds, default 0 |
| clientrem2 | Optional | remind client before event, value in seconds, default 0 |
| clientrem3 | Optional | remind client before event, value in seconds, default 0 |
| provrem1 | Optional | remind client before event, value in seconds, default 0 |
| provrem2 | Optional | remind client before event, value in seconds, default 0 |
| provrem3 | Optional | remind client before event, value in seconds, default 0 |
| txtclientrem1 | Optional | text remind client before event, value in seconds, default 0 |
| txtclientrem2 | Optional | text remind client before event, value in seconds, default 0 |
| txtclientrem3 | Optional | text remind client before event, value in seconds, default 0 |
| txtprovrem1 | Optional | text remind client before event, value in seconds, default 0 |
| txtprovrem2 | Optional | text remind client before event, value in minutes, default 0 |
| txtprovrem3 | Optional | text remind client before event, value in minutes, default 0 |
| preptime | Optional | Enter the time it takes the assigned adviser to prepare before this service occurs. This time will be marked as not available when this service is booked." in minutes |
| finishtime | Optional | Enter the time it takes the assigned adviser to finish up after this service occurs. This time will be marked as not available when this service is booked." in minutes, default 0 |
| invoiceid | Optional | Invoice’s ID |
Request:
JSON
{
"ID":"123",
"description":"Some description",
other parameters
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "Id of changed schedule"
]
}
Delete Schedule
URL: https://gigabook.com/api/schedules/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Client’s ID |
Request:
"ID":"123"
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "Id of changed schedule"
]
}
Restore A Deleted Schedule
URL: https://gigabook.com/api/schedules/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Client’s ID |
Request:
"ID":"123"
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "Id of changed schedule"
]
}
Invoice
Get Invoice List
URL: https://gigabook.com/api/invoices/list
Methods: POST
| Parameters | Required/Optional | Description |
| "clientName" | Optional | Client’s name |
| "Notes" | Optional | Notes about client |
| "date_start" | Optional | Invoices which starts from the date |
| "date_end" | Optional | Invoices which end until the date |
| sort_field | Optional | Select information about client in ‘string’ |
| sort | Required | In row descending or ascending in ‘enum string’ (asc, desc) |
| deleted | Optional | Deleted invoice lists enum (0, 1) |
| limit | Optional | Length of invoice list, default 30 |
| page | Optional | Page number, default 1 |
| status | Optional | Status of invoice enum ('pending', cancelled, paid) |
| amount_min | Optional | Minimum of bill amount |
| amount_max | Optional | Maximum of bill amount |
Example
Request:
JSON
{
"clientName": "John Doe",
"Notes": "Good guy",
"date_start": "8/9/2015",
"date_end": "8/10/2015",
"sort_field": 'string',
"sort": "asc",
"deleted": "",
"limit": "5",
"page": "3",
"status": "paid",
"amount_min": "500",
"amount_max": "10000"
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message":"",
"data" : [
[
"ID":"ID",
"SchedLnkID":"547",
"ClientID":"744",
"ClientName":"John Doe",
"ClientAddress":"Lion st. 98, ap.87",
"ClientEmail":"Client@Email.com",
"ClientCity":"Minnesota",
"ClientState":"Saint Paul",
"ClientCountry":"USA",
"ClientZipCode": "45677",
"Status":"cancelled",
"DateDisplay":"10/08/2016",
"DateCreated":"DateCreated",
"TaxRate":"TaxRate",
"TaxAmount":"TaxAmount",
"InvoiceNumber":"477",
"DateDue":"DateDue",
"Subtotal":"Subtotal",
"Total":"Total",
"PaidAmount":"PaidAmount",
"Notes":"Notes",
"NotesInternal":"NotesInternal",
"Terms":"Terms",
"Discount":"Discount",
"deleted":"deleted",
"invoice_lines" : {
"ID":"ID",
"InvoiceID":"InvoiceID",
"Item":"Item",
"Quantity":"Quantity",
"UnitPrice":"UnitPrice"
}
]
]
}
Get An Invoice
URL: https://gigabook.com/api/invoices/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Client’s ID in ‘string’ |
Example
Request:
"ID"="4501"
Response:
JSON
{
"success":"true",
"error":"false",
"error_message":"",
"data" : [
"ID":"4714",
"SchedLnkID":"6587",
"ClientID":"214",
"ClientName":"John Doe",
"ClientAddress":"Washington st. 88",
"ClientEmail":"Client@Email.com",
"ClientCity":"Richmond",
"ClientState":"Virginia",
"ClientCountry":"USA",
"ClientZipCode": "2334",
"Status":"panding",
"DateDisplay":"10/8/2015",
"DateCreated":"10/07/2015",
"TaxRate":"21",
"TaxAmount":"25",
"InvoiceNumber":"455",
"DateDue":"11/11/2015",
"Subtotal":"4577",
"Total":"4800",
"PaidAmount":"5200", //payed summary
"Notes":"Notes",
"NotesInternal":"NotesInternal",
"Terms":"Terms",
"Discount":"Discount",
"deleted":"deleted",
"invoice_lines" : [
[
"ID":"ID",
"Item":"Item",
"Quantity":"Quantity",
"UnitPrice":"UnitPrice"
]
],
]
}
Add An Invoice
URL: https://gigabook.com/api/invoices/add
Methods: POST
| Parameters | Required/Optional | Description |
| ClientID | Required | Client’s ID (can be optional if you have ClientName) |
| ClientName | Required | Client’s name (can be optional if you have ClientID) |
| ClientCompanyName | Optional | Client’s company name in ’string’ |
| ClientAddress | Optional | Client’s address in ’string’ |
| ClientEmail | Optional | Client’s email in ’string’ |
| ClientCity | Optional | Client’s city in ’string’ |
| ClientState | Optional | Client’s state in ’string’ |
| ClientCountry | Optional | Client’s country in ’string’ |
| ClientZipCode | Optional | Client’s zip code in ’string’ |
| SchedLnkID | Optional | In integer |
| Status | Required | Invoice status in enum ('pending', cancelled, paid) |
| InvoiceNumber | Required | Invoice number |
| DateDisplay | Required | In date format Data of get a paycheck |
| DateDue | Optional | In date format |
| Terms | Required | In enum ('Terms', 'Due Now', 'Net 7', 'Net 15', 'Net 30', 'Net 90', 'Net 180') |
| TaxRate | Optional | In float |
| Discount | Optional | In float |
| Notes | Optional | In ‘string’ |
| NotesInternal | Optional | In ‘string’ |
| invoiceLines | Required | Object |
| invoiceLines.Item | Required | Item in the invoice line In ‘string’ |
| invoiceLines.Quantity | Required | In integer |
| invoiceLines.UnitPrice | Required | In float |
Example
Request:
JSON
{
"ClientID": "447",
"ClientName":"Jimmy Doe",
"ClientAddress":"Green ave.1129",
"ClientEmail":"Client@Email.com",
"ClientCity":"Miami",
"ClientState":"Florida",
"ClientCountry":"USA",
"ClientZipCode":"2311",
"SchedLnkID":"4512",
"Status":"paid",
"InvoiceNumber":"12309",
"DateDisplay":"10/8/2015",
"DateDue":"10/10/2015",
"Terms":"Terms",
"TaxRate":"5",
"Discount":"33",
"Notes":"Notes"',
"NotesInternal":"NotesInternal"',
"invoiceLines": [
{
"Item":"Item",
"Quantity":"2",
"UnitPrice":"30"
}
]
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Update invoice
URL: https://gigabook.com/api/invoices/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Invoice Id |
| ClientID | Required | Client’s ID (can be optional if you have Client name) |
| ClientName | Required | Client’s name (can be optional if you have Client ID) |
| ClientCompanyName | Optional | Client’s company name in ’string’ |
| ClientAddress | Optional | Client’s address in ’string’ |
| ClientEmail | Optional | Client’s email in ’string’ |
| ClientCity | Optional | Client’s city in ’string’ |
| ClientState | Optional | Client’s state in ’string’ |
| ClientCountry | Optional | Client’s country in ’string’ |
| ClientZipCode | Optional | Client’s zip code in ’string’ |
| SchedLnkID | Optional | In integer Id of connected schedules |
| Status | Optional | Invoice status in enum ('pending', cancelled, paid) |
| InvoiceNumber | Required | Invoice number |
| DateDisplay | Required | In date format Data of get a paycheck |
| DateDue | Optional | In date format Deadline of payment |
| Terms | Optional | In enum ('Terms', 'Due Now', 'Net 7', 'Net 15', 'Net 30', 'Net 90', 'Net 180') |
| TaxRate | Optional | In float |
| Discount | Optional | In float |
| Notes | Optional | In ‘string’ |
| NotesInternal | Optional | In ‘string’ |
| invoiceLines | Optional | Object |
| invoiceLines.Item | Required | Item of the invoice line In ‘string’ |
| invoiceLines.Quantity | Required | In integer |
| invoiceLines.UnitPrice | Required | In float |
| InvoiceLines: ["ID":"ID", "Item":"Item", "Quantity":"Quantity", "UnitPrice":"UnitPrice"] | Optional | If you want to update InvoiceLines simultaneously with invoice you must add this parameter Only if you want to add invoice lines or edit (if ‘edit’ you must request InvoiceLines_id) |
| invoicelinesdel [ID1, ID2 ...] | Optional | If you want to delete InvoiceLines simultaneously with invoice you must add this parameter with id of invoice_lines |
Example
Request:
JSON
{
"ID":458,
"ClientID": "710",
"ClientName":"Sarah Connor",
"ClientAddress":"Holly hills st. 98",
"ClientEmail":"client@mail.com",
"ClientCity":"Los Angeles",
"ClientState":"California",
"ClientCountry":"USA",
"ClientZipCode":"233",
"SchedLnkID":"4573",
"Status":"cancelled",
"InvoiceNumber":"477",
"DateDisplay":"10/08/2015",
"DateDue":"10/09/2015",
"Terms":"Terms",
"TaxRate":"7",
"Discount":"5",
"Notes":"Notes",
"NotesInternal":"NotesInternal",
"invoiceLines": [
{
"ID":"ID",
"Item":"Item",
"Quantity":"Quantity",
"UnitPrice":"UnitPrice"
}
],
"Invoicelinesdel": [11, 12]
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Delete An Invoice
URL: https://gigabook.com/api/invoices/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Invoice ID in string |
Example
Request:
"id":"97"
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Restore invoice
URL: https://gigabook.com/api/invoices/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Invoice ID in ‘string’ |
Request:
"id":"54"
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Invoice Lines
Get Invoice Lines
URL: https://gigabook.com/api/invoices/lines
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Invoice ID |
Example
Request:
"ID"="9220"
Response:
JSON
{
"success":"true",
"error": "false",
"error_message": "",
"data": [
"ID":"ID",
"InvoiceID":"InvoiceID",
"Item":"Item",
"Description":"Description",
"Quantity":"Quantity",
"UnitPrice":"UnitPrice",
"Total":"Total",
"ServiceID":"ServiceID",
"GroupID":"GroupID"
]
}
Add An Invoice Line
URL: https://gigabook.com/api/invoices/line_add
Methods: POST
| Parameters | Required/Optional | Description |
| invoice_id | Required | Invoice ID |
| Item | Required | Item of invoice line in ‘string’ |
| Quantity | Required | Quantity of items |
| UnitPrice | Required | Unit price (item*quantity) |
Example
Request:
JSON
{
"invoice_id":"359",
"Item":"Item",
"Quantity":"50",
"UnitPrice":"10"
}
Response:
JSON
{
"success":"true",
"error": "false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Update An Invoice Line
URL: https://gigabook.com/api/invoices/line_update
Methods: POST
| Parameters | Required/Optional | Description |
| Id | Required | Id of invoice line |
| invoice_id | Required | Id of invoice |
| Item | Required | Item’s title of invoice |
| Quantity | Required | Quantity of items |
| UnitPrice | Required | Item price |
Example
Request:
JSON
{
"id":"line_id",
"invoice_id":"invoice_id",
"Item":"Item",
"Quantity":"Quantity",
"UnitPrice":"UnitPrice"
}
Response:
JSON
{
"success":"true",
"error": "false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Delete An Invoice Line
URL: https://gigabook.com/api/invoices/line_delete
Methods: POST
| Parameters | Required/Optional | Description |
| Invoice_id | Required | Id of invoice |
| ID | Required | Id of invoice line in ‘string’ |
Example
Request:
JSON
{
"invoice_id":"invoice_id",
"id":"line_id"
}
Response:
JSON
{
"success":"true",
"error":"false",
"error_message": "",
"data": [
"ID": "ID of changed item"
]
}
Custom Forms
Get Custom Forms List
URL: https://gigabook.com/api/custom-forms/list
Methods: GET
Example
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "9",
"Title": "My First Custom Form",
"Description": "This is my first custom form using API",
"Hide": "0",
"DateCreated": "2018-09-05 10:42:59",
"LastModified": "2018-09-05 11:19:31",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega",
"deleted": "0",
"BusInfoID": "6075",
"HideTitle": "0",
"HideDescription": "0",
"AlwaysOnBookWidget": "1",
"AlwaysOnGroupWidget": "0",
"AlwaysOnContactWidget": "1",
"slug": null
},
{
"ID": "10",
"Title": "My Second Custom Form",
"Description": "This is my second custom form using API",
"Hide": "0",
"DateCreated": "2018-09-06 13:53:14",
"LastModified": "2018-09-07 11:15:36",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega",
"deleted": "0",
"BusInfoID": "6075",
"HideTitle": "0",
"HideDescription": "0",
"AlwaysOnBookWidget": "1",
"AlwaysOnGroupWidget": "0",
"AlwaysOnContactWidget": "1",
"slug": null
}
]
}
Get A Custom Forms by ID
URL: https://gigabook.com/api/custom-forms/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | custom forms’ ID in ‘string’ |
Request:
ID=9
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "9",
"Title": "My First Custom Form",
"Description": "This is my first custom form using API",
"Hide": "0",
"DateCreated": "2018-09-05 10:42:59",
"LastModified": "2018-09-05 11:19:31",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega",
"deleted": "0",
"BusInfoID": "6075",
"HideTitle": "0",
"HideDescription": "0",
"AlwaysOnBookWidget": "1",
"AlwaysOnGroupWidget": "0",
"AlwaysOnContactWidget": "1",
"slug": null
}
]
}
Add A Custom Forms
URL: https://gigabook.com/api/custom-forms/add
Methods: POST
| Parameters | Required/Optional | Description |
| Title | Required | String |
| Description | Optional | String |
| Hide | Optional | String in YN type |
| HideTitle | Optional | String in YN type |
| HideDescription | Optional | String in YN type |
| AlqaysOnBookWidget | Optional | String in YN type |
| AlwaysOnGroupWidget | Optional | String in YN type |
| AlwaysOnContactWidget | Optional | String in YN type |
| Questions | Optional | Array of Questions. ('QuestionText', 'Type', 'Required') |
Example
Request:
JSON
{
"Title": "Form for Hair Salon 2",
"Description": "This is my first custom form with API",
"Hide": "N",
"HideTitle": "N",
"HideDescription": "N",
"AlwaysOnBookWidget": "Y",
"AlwaysOnGroupWidget": "Y",
"AlwaysOnContactWidget": "Y",
"Questions": [
{
"QuestionText": "What is your name 2?",
"Type": "text",
"Required": "Y"
},
{
"QuestionText": "How old are you 2?",
"Type": "text",
"Required": "Y"
}
]
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "23",
"Title": "Form for Hair Salon 2",
"Description": "This is my first custom form with API",
"Hide": "0",
"DateCreated": "2018-10-24 10:53:29",
"LastModified": "2018-10-24 10:53:29",
"ModifiedBy": "Another Test",
"CreatedBy": "Another Test",
"deleted": "0",
"BusInfoID": "6086",
"HideTitle": "0",
"HideDescription": "0",
"AlwaysOnBookWidget": "1",
"AlwaysOnGroupWidget": "1",
"AlwaysOnContactWidget": "1",
"slug": null,
"Questions": [
{
"ID": "35",
"Title": null,
"Description": null,
"Hide": null,
"DateCreated": "2018-10-24 10:53:29",
"LastModified": "2018-10-24 10:53:29",
"ModifiedBy": "Another Test",
"CreatedBy": "Another Test",
"deleted": "0",
"QuestionText": "What is your name 2?",
"Type": "text",
"AnswerChoices": null,
"CustomFormID": "23",
"SortOrder": "5",
"Required": "1",
"HasSubQuestion": null,
"AnswerToShowSubQuestion": null,
"ParentQuestionId": null
},
{
"ID": "36",
"Title": null,
"Description": null,
"Hide": null,
"DateCreated": "2018-10-24 10:53:29",
"LastModified": "2018-10-24 10:53:29",
"ModifiedBy": "Another Test",
"CreatedBy": "Another Test",
"deleted": "0",
"QuestionText": "How old are you 2?",
"Type": "text",
"AnswerChoices": null,
"CustomFormID": "23",
"SortOrder": "10",
"Required": "1",
"HasSubQuestion": null,
"AnswerToShowSubQuestion": null,
"ParentQuestionId": null
}
]
}
}
Update A Custom Forms
URL: https://gigabook.com/api/custom-forms/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Custom Form ID in 'string' |
| Title | Optional | String |
| Description | Optional | String |
| Hide | Optional | String in YN type |
| HideTitle | Optional | String in YN type |
| HideDescription | Optional | String in YN type |
| AlqaysOnBookWidget | Optional | String in YN type |
| AlwaysOnGroupWidget | Optional | String in YN type |
| AlwaysOnContactWidget | Optional | String in YN type |
Request:
JSON
{
"ID": "11",
"Title": "My Second Updated Custom Form",
"Description": "This is my second custom form using API",
"Hide": "N",
"HideTitle": "N",
"HideDescription": "N",
"AlwaysOnBookWidget": "Y",
"AlwaysOnGroupWidget": "N",
"AlwaysOnContactWidget": "Y"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "11",
"Title": "My Second Updated Custom Form",
"Description": "This is my second custom form using API",
"Hide": "0",
"DateCreated": "2018-09-06 14:04:49",
"LastModified": "2018-10-24 11:02:38",
"ModifiedBy": "Aner Ortega",
"BusInfoID": "6075",
"HideTitle": "0",
"HideDescription": "0",
"AlwaysOnBookWidget": "1",
"AlwaysOnGroupWidget": "0",
"AlwaysOnContactWidget": "1"
}
}
Delete a Custom Forms
URL: https://gigabook.com/api/custom-forms/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Custom Form ID in ‘string’ |
Example
Request:
"ID": "11"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "11"
}
}
Restore Resources
URL: https://gigabook.com/api/custom-forms/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Custom Forms’ ID |
Example
Request:
JSON
{
"ID": "11"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "11"
}
}
Custom Forms - Questions
Get Questions List
URL: https://gigabook.com/api/questions/list
Methods: GET
Example
| Parameters | Required/Optional | Description |
| CustomFormID | Required | Custom Form ID in ‘string’ |
Request:
ID=9
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "19",
"QuestionText": "Is this your first project?",
"Description": null,
"Type": "checkboxes",
"AnswerChoices": "No, Yes, Maybe",
"CustomFormID": "9",
"SortOrder": "1",
"Required": "0",
"DateCreated": "2018-09-05 13:27:13",
"LastModified": "2018-09-06 06:36:11",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega",
"deleted": "0",
"HasSubQuestion": null,
"AnswerToShowSubQuestion": null,
"ParentQuestionId": null
},
{
"ID": "20",
"QuestionText": "Is this your firs project?",
"Description": null,
"Type": "checkboxes",
"AnswerChoices": "Yes, No",
"CustomFormID": "9",
"SortOrder": "1",
"Required": "1",
"DateCreated": "2018-09-06 14:31:39",
"LastModified": "2018-09-06 14:31:39",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega",
"deleted": "0",
"HasSubQuestion": null,
"AnswerToShowSubQuestion": null,
"ParentQuestionId": null
}
]
}
Get A Question by ID
URL: https://gigabook.com/api/questions/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Question ID in ‘string’ |
Request:
ID=19
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "19",
"QuestionText": "Is this your first project?",
"Description": null,
"Type": "checkboxes",
"AnswerChoices": "No,Yes,Maybe",
"CustomFormID": "9",
"SortOrder": "1",
"Required": "0",
"DateCreated": "2018-09-05 13:27:13",
"LastModified": "2018-09-07 08:52:59",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega",
"deleted": "0",
"HasSubQuestion": "1",
"AnswerToShowSubQuestion": null,
"ParentQuestionId": null
}
]
}
Add A Question
URL: https://gigabook.com/api/questions/add
Methods: POST
| Parameters | Required/Optional | Description |
| QuestionText | Required | String |
| Type | Required | Any of the following: 'radio', 'select', 'checkboxes', 'text', 'textarea', 'date', 'datetime', 'time', 'daterange', 'datetimerange', 'timerance', 'color', 'hidden' |
| CustomFormID | Required | Custom Form ID in 'string' |
| AnswerChoices | optional | Comma separated values. Required for Type: radio, select, checkboxes, daterange, datetimerange, timerange |
| SortOrder | Optional | Integer |
| HasSubQuestion | Required | String in 'YN' type |
| ParentQuestionID | Optional | String in 'integer' |
| Required | Required | String in 'YN' type |
Example
Request:
JSON
{
"QuestionText": "Is it still raining today?",
"Type": "radio",
"AnswerChoices": "Yes,No",
"CustomFormID": "9",
"SortOrder": "12",
"HasSubQuestion": "N",
"Required": "Y"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "37",
"QuestionText": "Is it still raining today?",
"Description": null,
"Type": "radio",
"AnswerChoices": "Yes,No",
"CustomFormID": "9",
"SortOrder": "12",
"Required": "1",
"DateCreated": "2018-10-24 12:59:29",
"LastModified": "2018-10-24 12:59:29",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega",
"HasSubQuestion": null,
"AnswerToShowSubQuestion": null,
"ParentQuestionId": null
}
}
Update A Question
URL: https://gigabook.com/api/questions/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Question ID in 'string' |
| QuestionText | Required | String |
| Type | Required | Any of the following: 'radio', 'select', 'checkboxes', 'text', 'textarea', 'date', 'datetime', 'time', 'daterange', 'datetimerange', 'timerance', 'color', 'hidden' |
| AnswerChoices | optional | Comma separated values. Required for Type: radio, select, checkboxes, daterange, datetimerange, timerange |
| SortOrder | Optional | Integer |
| HasSubQuestion | Required | String in 'YN' type |
| ParentQuestionID | Optional | String in 'integer' |
| Required | Required | String in 'YN' type |
Request:
JSON
{
"ID": "20",
"SortOrder": "11",
"Required": "y"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "20",
"QuestionText": "Are you married?",
"Description": null,
"Type": "checkboxes",
"AnswerChoices": "Yes, No",
"CustomFormID": "9",
"SortOrder": "11",
"Required": "1",
"DateCreated": "2018-09-06 14:31:39",
"LastModified": "2018-10-24 13:07:47",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega",
"HasSubQuestion": null,
"AnswerToShowSubQuestion": null,
"ParentQuestionId": null
}
}
Delete a Question
URL: https://gigabook.com/api/questions/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Question ID in ‘string’ |
Example
Request:
"ID": "21"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "21"
}
}
Restore Question
URL: https://gigabook.com/api/questions/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Question ID in 'string' |
Example
Request:
JSON
{
"ID": "21"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "21"
}
}
Custom Forms - Answers
Get Answers List
URL: https://gigabook.com/api/answers/list
Methods: GET
Example
| Parameters | Required/Optional | Description |
| CustomFormID | Optional | Custom Form ID in ‘string’ |
| ScheduleID | Optional | Custom Form ID in ‘string’ |
Request:
ScheduleID=557827&CustomFormID=9
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "58",
"ClientID": "91974",
"ScheduleID": "557827",
"ServiceID": "9919",
"GroupID": null,
"BusInfoID": "6075",
"CustomFormID": "9",
"QuestionID": "19",
"AnswerText": "No",
"Timestamp": null,
"deleted": "0",
"DateCreated": "2018-09-07 12:52:13",
"LastModified": "2018-09-07 12:52:13",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega"
}
]
}
Get An Answer by ID
URL: https://gigabook.com/api/answers/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Answer ID in ‘string’ |
Request:
ID=54
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "54",
"ClientID": "4087",
"ScheduleID": "0",
"ServiceID": null,
"GroupID": "0",
"BusInfoID": "6075",
"CustomFormID": "9",
"QuestionID": "19",
"AnswerText": "No",
"Timestamp": "2018-09-06 15:26:38",
"deleted": "0",
"DateCreated": "2018-09-06 08:48:18",
"LastModified": "2018-09-06 10:26:38",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega"
}
]
}
Add An Answer
URL: https://gigabook.com/api/answers/add
Methods: POST
| Parameters | Required/Optional | Description |
| QuestionID | Required | Question ID in 'string' |
| ClientID | Required | Client ID in 'string' |
| ServiceID | Optional | Servide ID in 'string' |
| ScheduleID | Required | Schedule ID in 'string' |
| AnswerText | Required | String |
Example
Request:
JSON
{
"QuestionID": "24",
"ClientID": "91974",
"ServiceID": "9919",
"ScheduleID": "557827",
"AnswerText": "Yes, it's raining"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "59",
"ClientID": "91974",
"ScheduleID": "557827",
"ServiceID": "9919",
"GroupID": null,
"BusInfoID": "6075",
"CustomFormID": "9",
"QuestionID": "24",
"AnswerText": "Yes, it's raining",
"Timestamp": "2018-09-10 18:18:43",
"DateCreated": "2018-09-10 08:34:25",
"LastModified": "2018-09-10 08:34:25",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega"
}
}
Update An Answer
URL: https://gigabook.com/api/answers/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Answer ID in 'string' |
| AnswerText | Required | String |
Request:
JSON
{
"ID": "64",
"QuestionID": "19",
"AnswerText": "Yes"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "64",
"ClientID": "91974",
"ScheduleID": "557827",
"ServiceID": "9919",
"GroupID": null,
"BusInfoID": "6075",
"CustomFormID": "9",
"QuestionID": "19",
"AnswerText": "Yes",
"Timestamp": "2018-10-24 19:50:40",
"DateCreated": "2018-09-18 09:41:40",
"LastModified": "2018-10-24 14:50:40",
"ModifiedBy": "Aner Ortega",
"CreatedBy": "Aner Ortega"
}
}
Delete an Answer
URL: https://gigabook.com/api/answers/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Answer ID in ‘string’ |
Example
Request:
"ID": "57"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "57"
}
}
Restore Answer
URL: https://gigabook.com/api/answers/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Answer ID in 'string' |
Example
Request:
JSON
{
"ID": "57"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "57"
}
}
Availability
Check Availability
URL: https://gigabook.com/api/availability/check
Methods: GET
Example
| Parameters | Required/Optional | Description |
| ServiceID | Required | Service ID in ‘string’ |
| BusInfoID | Optional | Business Info ID in ‘string’ |
| BookingDate | Optional | Date. Accepts multiple dates separated with comma. Any date format is accepted. If BookingDate is not passed, current date will be used. |
| Timezone | Optional | String. If not passed, the business timezone data will be used. |
Request:
ServiceID=9923&BookingDate=2018/09/18,2018/9/20&Timezone=Asia/Hong_Kong
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"dates": [
{
"date": "2018/09/18",
"date_formatted": "Tue Sep 18",
"times": {
"times": [
"9/18/2018 8:00 am",
"9/18/2018 11:00 am",
"9/18/2018 2:00 pm",
"9/18/2018 3:00 pm",
"9/18/2018 4:00 pm"
],
"times_adjusted": [
"9/18/2018 8:00 pm",
"9/18/2018 11:00 pm",
"9/19/2018 2:00 am",
"9/19/2018 3:00 am",
"9/19/2018 4:00 am"
],
"providers": [
"13587"
],
"providers_times": [
{
"provider": "13587",
"time": "8:00 am",
"time_adjusted": "8:00 pm"
},
{
"provider": "13587",
"time": "11:00 am",
"time_adjusted": "11:00 pm"
},
{
"provider": "13587",
"time": "2:00 pm",
"time_adjusted": "2:00 am"
},
{
"provider": "13587",
"time": "3:00 pm",
"time_adjusted": "3:00 am"
},
{
"provider": "13587",
"time": "4:00 pm",
"time_adjusted": "4:00 am"
}
],
"client_tz_adjustment": 12,
"debug": "",
"total_duration": 60
}
},
{
"date": "2018/9/21",
"date_formatted": "Fri Sep 21",
"times": {
"times": [
"9/21/2018 8:00 am",
"9/21/2018 9:00 am",
"9/21/2018 10:00 am",
"9/21/2018 11:00 am",
"9/21/2018 12:00 pm",
"9/21/2018 1:00 pm",
"9/21/2018 2:00 pm",
"9/21/2018 3:00 pm",
"9/21/2018 4:00 pm"
],
"times_adjusted": [
"9/21/2018 8:00 pm",
"9/21/2018 9:00 pm",
"9/21/2018 10:00 pm",
"9/21/2018 11:00 pm",
"9/22/2018 12:00 am",
"9/22/2018 1:00 am",
"9/22/2018 2:00 am",
"9/22/2018 3:00 am",
"9/22/2018 4:00 am"
],
"providers": [
"13587"
],
"providers_times": [
{
"provider": "13587",
"time": "8:00 am",
"time_adjusted": "8:00 pm"
},
{
"provider": "13587",
"time": "9:00 am",
"time_adjusted": "9:00 pm"
},
{
"provider": "13587",
"time": "10:00 am",
"time_adjusted": "10:00 pm"
},
{
"provider": "13587",
"time": "11:00 am",
"time_adjusted": "11:00 pm"
},
{
"provider": "13587",
"time": "12:00 pm",
"time_adjusted": "12:00 am"
},
{
"provider": "13587",
"time": "1:00 pm",
"time_adjusted": "1:00 am"
},
{
"provider": "13587",
"time": "2:00 pm",
"time_adjusted": "2:00 am"
},
{
"provider": "13587",
"time": "3:00 pm",
"time_adjusted": "3:00 am"
},
{
"provider": "13587",
"time": "4:00 pm",
"time_adjusted": "4:00 am"
}
],
"client_tz_adjustment": 12,
"debug": "",
"total_duration": 60
}
}
],
"debug": ""
}
}
Add Ons
Get Add Ons List
URL: https://gigabook.com/api/add-ons/list
Methods: GET
Example
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"id": "919",
"name": "Aner AddOn",
"price": "1.00",
"inventory": "1",
"number_available": "3",
"tax": "2.00",
"tax_active": "1",
"short_desc": "First AddOn of this account. Let us take a look on this now.",
"long_desc": "",
"image": "blank_logo.jpg",
"have_title": "1",
"add_on_title": "This is My Frist AddOn",
"businfolnkid": "6076",
"deleted": "0",
"sort_order": null,
"serviceid": "",
"groupid": "",
"active": "1",
"show_booking_widget": "1",
"show_group_widget": "1",
"slug": null
},
{
"id": "920",
"name": "Chicharon For Sale",
"price": "0.30",
"inventory": "0",
"number_available": "-1",
"tax": "0.00",
"tax_active": "0",
"short_desc": null,
"long_desc": null,
"image": "blank_logo.jpg",
"have_title": "0",
"add_on_title": "",
"businfolnkid": "6076",
"deleted": "0",
"sort_order": null,
"serviceid": "-1",
"groupid": "-1",
"active": "1",
"show_booking_widget": "0",
"show_group_widget": "0",
"slug": null
}
]
}
Get An Add On by ID
URL: https://gigabook.com/api/add-ons/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Add On ID in ‘string’ |
Request:
ID=919
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"id": "919",
"name": "Aner AddOn",
"price": "1.00",
"inventory": "1",
"number_available": "3",
"tax": "2.00",
"tax_active": "1",
"short_desc": "First AddOn of this account. Let us take a look on this now.",
"long_desc": "",
"image": "blank_logo.jpg",
"have_title": "1",
"add_on_title": "This is My Frist AddOn",
"businfolnkid": "6076",
"deleted": "0",
"sort_order": null,
"serviceid": "",
"groupid": "",
"active": "1",
"show_booking_widget": "1",
"show_group_widget": "1",
"slug": null
}
]
}
Add An Add On
URL: https://gigabook.com/api/add-ons/add
Methods: POST
| Parameters | Required/Optional | Description |
| Name | Required | String |
| Price | Required | Numeric |
| Number_Available | Optional | Integer |
| Tax | Optional | Numeric |
| Tax_Active | Optional | String in 'YN' type |
| Short_Desc | Optional | String |
| Long_Desc | Optional | String |
| ImageDate | Optional | Base64 Encoded Image |
| Show_On_Booking_Widget | Optional | String in 'YN' type |
| Show_On_Group_Session_Widget | Optional | String in 'YN' type |
| Add_On_Title | Optional | String |
| ServiceID | Optional | Array of Service IDs |
| GroupID | Optional | Array of Group IDs |
| Active | Required | String in 'YN' type |
Example
Request:
JSON
{
"name": "Ampao For Sale 31",
"price": "0.25",
"number_available": "80",
"show_on_booking_widget": "N",
"show_on_group_session_widget": "N",
"serviceid": ["9926","9927"],
"groupid": ["3662","3663"],
"active": "Y",
"imagedata": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAbsAAAGxCAYAAAD78hh4AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAP+lSURBVHhe7H0FeBzX1XbK7de/DF+/lNOmdZumTVMKNdQwNcxMDccBJ3Fsx8zMTLLAssVgWZZlWczMjCvm1Yql9z/nzN7VaL2SZVlKZHfOPueZy/fcuzPnnXNpLjh+/DgMMsgggwwy6HwmA+wMMsgggww67+kUsPve975nsMEGG2ywwecFK4xzCHYGGWSQQQYZdD6QAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgYZZJBBBp33ZICdQQYZZJBB5z0ZYGeQQQYZZNB5TwbYGWSQQQYZdN6TAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgYZZJBBBp33ZICdQQYZZJBB5z0ZYGeQQQYZZNB5TwbYGWSQQQYZdN6TAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgZNGqWvvRUXXXTRiHzJ5Vfhnte34UR5tzWHHcUvxbX6PPdtQ6E1anTqRnncfix59h5c8cdpQ/kvuRxX3fMsluyPw0hVDlET3J7X5b3oMswIPm0mmLPcMfvhm4bVe8nlN+Hh2fsRd/pKqcnX6uq8CPdtG1uL9XS6frfnN7ytGT8LSl+LW5Usn6kgBp3vZICdQZNGY1a6lz8PNwc6PWrhlXZp78NpdX93CnY+dQWmDct3Kk…………… “
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "930",
"name": "Ampao For Sale 31",
"price": "0.25",
"inventory": "1",
"number_available": "80",
"tax": "0.00",
"tax_active": "0",
"short_desc": null,
"long_desc": null,
"image": "addon_Ampao_For_Sale_31.png",
"have_title": "0",
"add_on_title": "",
"businfolnkid": "6076",
"deleted": "0",
"sort_order": null,
"serviceid": "9926,9927",
"groupid": "3662,3663",
"active": "1",
"show_booking_widget": "0",
"show_group_widget": "0",
"slug": null
}
}
Update An Add On
URL: https://gigabook.com/api/add-ons/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Add On ID in 'string' |
| Name | Optional | String |
| Price | Optional | Numeric |
| Number_Available | Optional | Integer |
| Tax | Optional | Numeric |
| Tax_Active | Optional | String in 'YN' type |
| Short_Desc | Optional | String |
| Long_Desc | Optional | String |
| ImageDate | Optional | Base64 Encoded Image |
| Add_On_Title | Optional | String |
| RemoveUploadImage | Optional | String in 'YN' type |
Request:
JSON
{
"id": "930",
"short_desc": "Car-car's best for Ampao",
"removeuploadimage": "Y"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "930",
"name": "Ampao For Sale 31",
"price": "0.25",
"inventory": "1",
"number_available": "80",
"tax": "0.00",
"tax_active": "0",
"short_desc": "Car-car's best for Ampao",
"long_desc": null,
"image": "blank_logo.jpg",
"have_title": "0",
"add_on_title": "",
"businfolnkid": "6076",
"deleted": "0",
"sort_order": null,
"serviceid": "9926,9927",
"groupid": "3662,3663",
"active": "1",
"show_booking_widget": "0",
"show_group_widget": "0",
"slug": null
}
}
Delete an Add On
URL: https://gigabook.com/api/add-ons/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Add On ID in ‘string’ |
Example
Request:
"ID": "919"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "919"
}
}
Restore Add On
URL: https://gigabook.com/api/add-ons/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Add On ID in 'string' |
Example
Request:
JSON
{
"ID": "919"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "919"
}
}
Group Sessions
Get Group Sessions List
URL: https://gigabook.com/api/meetings/list
Methods: GET
Example
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "3664",
"BusInfoLnkID": "6076",
"Name": "Another Groupie",
"Description": "Description of another groupie",
"PrepTime": "0",
"Duration": "",
"Hide": "N",
"AccountEmailAdd": "atortega@yahoo.com",
"AcctLnkID": "4088",
"Price": "0.00",
"MinAttendees": "0",
"MaxAttendees": "0",
"PageHtml": "
",
"FinishTime": "0",
"MainImage": "group_Description_of_another_groupie1.png"
},
{
"ID": "3665",
"BusInfoLnkID": "6076",
"Name": "Another Groupie 2",
"Description": "Description of another groupie",
"PrepTime": "0",
"Duration": "",
"Hide": "N",
"AccountEmailAdd": "atortega@yahoo.com",
"AcctLnkID": "4088",
"Price": "0.00",
"MinAttendees": "0",
"MaxAttendees": "0",
"PageHtml": "
",
"FinishTime": "0",
"MainImage": "group_Description_of_another_groupie2.png"
}
]
}
Get A Group Session by ID
URL: https://gigabook.com/api/meetings/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Group Session ID in ‘string’ |
Request:
ID=3663
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "3663",
"BusInfoLnkID": "6076",
"Name": "MySecondGroupie",
"Description": "",
"PrepTime": "0",
"Duration": "1|00",
"Venue": "",
"Hide": "N",
"AccountEmailAdd": "atortega@yahoo.com",
"AcctLnkID": "4088",
"Price": "0.02",
"MinAttendees": "7",
"MaxAttendees": "15",
"PageHtml": "
",
"FinishTime": "0",
"MainImage": "blank_logo.jpg"
}
}
Add A Group Session
URL: https://gigabook.com/api/meetings/add
Methods: POST
| Parameters | Required/Optional | Description |
| GroupName | Required | String |
| Description | Optional | String |
| PageHtml | Optional | String |
| PrepTime | Optional | Time format (hh:mm) |
| FinishTime | Optional | Time format (hh:mm) |
| Duration | Optional | Time format (hh:mm) |
| HideGroup | Optional | String in 'YN' type |
| MinAttendees | Optional | Integer |
| MaxAttendees | Optional | Integer |
| Price | Optional | Numeric |
| ImageData | Optional | Base64 Encoded Image |
Example
Request:
JSON
{
"GroupName": "Another Groupie 3",
"Duration": "5:00",
"imagedata": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAbsAAAGxCAYAAAD78hh4AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAP+lSURBVHhe7H0FeBzX1XbK7de/DF+/lNOmdZumTVMKNdQwNcxMDccBJ3Fsx8zMTLLAssVgWZZlWczMjCvm1Yql9z/nzN7VaL2SZVlKZHfOPueZy/fcuzPnnXNpLjh+/DgMMsgggwwy6HwmA+wMMsgggww67+kUsPve975nsMEGG2ywwecFK4xzCHYGGWSQQQYZdD6QAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgYZZJBBBp33ZICdQQYZZJBB5z0ZYGeQQQYZZNB5TwbYGWSQQQYZdN6TAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgYZZJBBBp33ZICdQQYZZJBB5z0ZYGeQQQYZZNB5TwbYGWSQQQYZdN6TAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgZNGqWvvRUXXXTRiHzJ5Vfhnte34UR5tzWHHcUvxbX6PPdtQ6E1anTqRnncfix59h5c8cdpQ/kvuRxX3fMsluyPw0hVDlET3J7X5b3oMswIPm0mmLPcMfvhm4bVe8nlN+Hh2fsRd/pKqcnX6uq8CPdtG1uL9XS6frfnN7ytGT8LSl+LW5Usn6kgBp3vZICdQZNGY1a6lz8PNwc6PWrhlXZp78NpdX93CnY+dQWmDct3K…….. “
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "3666",
"BusInfoLnkID": "6076",
"Name": "Another Groupie 3",
"Description": null,
"PrepTime": "0",
"Duration": "5|00",
"Venue": "",
"Hide": "N",
"AccountEmailAdd": "atortega@yahoo.com",
"AcctLnkID": "4088",
"Price": "0.00",
"MinAttendees": "0",
"MaxAttendees": "0",
"PageHtml": "
",
"FinishTime": "0",
"MainImage": "group_.png"
}
}
Update A Group Session
URL: https://gigabook.com/api/meetings/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Group Session ID in 'string' |
| GroupName | Optional | String |
| Description | Optional | String |
| PageHtml | Optional | String |
| PrepTime | Optional | Time format (hh:mm) |
| FinishTime | Optional | Time format (hh:mm) |
| Duration | Optional | Time format (hh:mm) |
| HideGroup | Optional | String in 'YN' type |
| MinAttendees | Optional | Integer |
| MaxAttendees | Optional | Integer |
| Price | Optional | Numeric |
| ImageData | Optional | Base64 Encoded Image |
Request:
JSON
{
"ID": "3666",
"Description": "My Description here",
"RemoveImage": "N",
"MinAttendees": "6",
"MaxAttendees": "12",
"Price": "1.00",
"PrepTime": "2:00",
"FinishTime": "0:45"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "3666",
"BusInfoLnkID": "6076",
"Name": "MyGroupie",
"Description": "My Description here",
"PrepTime": "120",
"Duration": "5|00",
"Hide": "N",
"AccountEmailAdd": "atortega@yahoo.com",
"AcctLnkID": "4088",
"Price": "1.00",
"MinAttendees": "6",
"MaxAttendees": "12",
"PageHtml": "
",
"FinishTime": "45",
"MainImage": "group_My_Description_here.png"
}
}
Delete A Group Session
URL: https://gigabook.com/api/meetings/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Group Session ID in ‘string’ |
Example
Request:
"ID": "3663"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "3663"
}
}
Restore Group Session
URL: https://gigabook.com/api/meetings/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Group Session ID in 'string' |
Example
Request:
JSON
{
"ID": "3663"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "3663"
}
}
Services
Get Services List
URL: https://gigabook.com/api/services/list
Methods: GET
Example
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "9919",
"Service": "test service",
"Description": "",
"PrepTime": "0",
"Duration": "1|00",
"Price": "1.00",
"FinishTime": "0",
"PageHtml": null
},
{
"ID": "9921",
"Service": "Spa Saloon",
"Description": null,
"PrepTime": "0",
"Duration": "1|00",
"Price": "2.00",
"FinishTime": "0",
"PageHtml": ""
}
]
}
Get A Service by ID
URL: https://gigabook.com/api/services/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Service ID in ‘string’ |
Request:
ID=9923
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "9923",
"BusInfoLnkID": "6075",
"Service": "First Saloon",
"Description": "The first saloon in town.",
"PrepTime": "0",
"Duration": "1|00",
"Hide": "N",
"Rem": "-",
"AccountEmailAdd": "anortega@fullscale.io",
"AcctLnkID": "4087",
"Price": "2.00",
"last_modified": "2018-09-11 19:36:08",
"CreatedBy": "Aner Ortega",
"ModifiedBy": "Aner Ortega",
"deleted": "0",
"PageHtml": "",
"PrepTime_old": "",
"FinishTime": "0",
"MainImage": "blank_logo.jpg",
"SortOrder": "5",
"slug": null,
"ClientLocation": "N",
"PriceVariable": "N"
}
]
}
Add A Service
URL: https://gigabook.com/api/services/add
Methods: POST
| Parameters | Required/Optional | Description |
| ServiceName | Required | String |
| Provider | Required | Array of Provider IDs |
| Duration | Required | Time format (hh:mm) |
| HideService | Required | String in 'YN' type |
| Price | Required | Numeric |
| PrepTime | Optional | Time format (hh:mm) |
| FinishTime | Optional | Time format (hh:mm) |
| ClientLocation | Required | String in 'YN' type |
| SortOrder | Optional | Integer |
| ImageData | Optional | Base64_Encoded Image |
Example
Request:
JSON
{
"ServiceName": "Barber Shop VI",
"Provider": ["13591"],
"Duration": "2:00",
"PrepTime": "1:00",
"FinishTime": "2:00",
"HideService": "N",
"Price": "1.50",
"ClientLocation": "N",
"ImageData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABgAAAALRCAYAAACdw2jyAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAP+lSURBVHhe7N0FnGxl3cDxZ+s23d2d0g0XpENppRVF8VVEFAXFAEQQESWUeIUXBBRQQro7LyFId3fL7bvxnt8z5+w9O3dmd2br7s7+vp/PfHZ25sypOfPE/4lTd/zxx7cFSX2utbW1/W9bW1t85NXX14fGxsb0v741derU+HfKlCmhoaEhbpe/7AOPurq6+L4kSZIkSep/kydPDiNGjEj/q15zc3N8SBq6svhe3W9+85sYhSwORkrqezQGZI8MgXgefSnfAJAF/20AkCRJkiRpYOhpAwD1fWJ91u+loSf/u+d53XHHHdeW9UiWNHPw+6NlPv87bGpq6rOMOmsA4G8W/LcBQJIkSZKkgaGnDQB8HtbvpaGD3ztxvUz2+687+uijOzQA2BAgzTz8FltaWtp/h33VCGADgCRJkiRJA5cNAJIq1R7oT/5mcT3ifJm6cePGtS299NJhjjnmSF+SJEmSJEmSJEmDxccffxyef/75cP3118fOxe0NAsk/dvmXJEmSJEmSJGmQ+/DDD8PFF18c3nvvvcJsH+nrkiRJkiRJkiRpEJt77rnDCius0D7NuA0AkiRJkiRJkiTViOWXXz42APCwAUCSJEmSJEmSpBrBKABHAEiSJEmSJEmSVGOGDx8eWltbbQCQJEmSJEmSJKnW0ADAwwYASZIkSZIkSZJqjCMAJEmSJEmSJEmqUTYASJIkSZIkSZJUQ+j9DxsAJE………. “
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "9931",
"BusInfoLnkID": "6076",
"Service": "Barber Shop VI",
"Description": null,
"PrepTime": "60",
"Duration": "2|00",
"Hide": "N",
"Rem": "-",
"AccountEmailAdd": "atortega@yahoo.com",
"AcctLnkID": "4088",
"Price": "1.50",
"last_modified": "2018-09-25 18:02:42",
"CreatedBy": "Aner Test",
"ModifiedBy": "Aner Test",
"deleted": "0",
"PageHtml": "",
"PrepTime_old": "",
"FinishTime": "120",
"MainImage": "service_Barber_Shop_VI.png",
"SortOrder": "0",
"slug": null,
"ClientLocation": "N",
"PriceVariable": "N"
}
}
Update A Service
URL: https://gigabook.com/api/services/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Service ID in 'string' |
| ServiceName | Optional | String |
| Provider | Optional | Array of Provider IDs |
| Duration | Optional | Time format (hh:mm) |
| HideService | Optional | String in 'YN' type |
| Price | Optional | Numeric |
| PrepTime | Optional | Time format (hh:mm) |
| FinishTime | Optional | Time format (hh:mm) |
| ClientLocation | Optional | String in 'YN' type |
| SortOrder | Optional | Integer |
| RemoveImage | Optional | String in 'YN' type |
| ImageData | Optional | Base64_Encoded Image |
Request:
JSON
{
"ID": "9926",
"ServiceName": "Hair Saloon 2",
"Description": "The first saloon in town.",
"SortOrder": "5",
"RemoveImage": "Y"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "9926",
"BusInfoLnkID": "6076",
"Service": "Hair Saloon 2",
"Description": "The first saloon in town.",
"PrepTime": "0",
"Duration": "2|00",
"Hide": "N",
"Rem": "-",
"AccountEmailAdd": "atortega@yahoo.com",
"AcctLnkID": "4088",
"Price": "3.00",
"last_modified": "2018-09-25 17:56:31",
"CreatedBy": "Aner Test",
"ModifiedBy": "Aner Test",
"deleted": "0",
"PageHtml": "",
"PrepTime_old": "",
"FinishTime": "0",
"MainImage": "blank_logo.jpg",
"SortOrder": "5",
"slug": null,
"ClientLocation": "N",
"PriceVariable": "N"
}
}
Delete A Service
URL: https://gigabook.com/api/services/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Service ID in ‘string’ |
Example
Request:
"ID": "9923"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "9923"
}
}
Restore A Service
URL: https://gigabook.com/api/services/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Service ID in 'string' |
Example
Request:
JSON
{
"ID": "9923"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "9923"
}
}
Locations
Get Locations List
URL: https://gigabook.com/api/locations/list
Methods: GET
Example
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": [
{
"ID": "6076",
"BusinessName": "Test - Aner Again",
"BusinessPhone": "",
"PhotoLogo": "blank_logo.jpg",
"BusinessWebsite": "",
"LocationName": "",
"Street": "",
"City": "",
"State": "",
"Zipcode": "",
"Rem": "-",
"Country": "",
"Timezone": "America/New_York",
"NoAdd": "N",
"UseMiniSite": "Y",
"GoogleCalActivate": "N",
"MondayIn": "08:00",
"TuesdayIn": "08:00",
"WednesdayIn": "08:00",
"ThursdayIn": "08:00",
"FridayIn": "08:00",
"SaturdayIn": "08:00",
"SundayIn": "08:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"AcctLnkID": "4088",
"AccountEmailAdd": "",
"CalStart": "1381",
"CalEnd": "1426",
"status": "",
"ExStat": "N",
"InfoStat": "",
"LastActivity": "",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "N",
"sunAvailability": "N",
"last_modified": "2018-09-19 11:57:30",
"CreatedBy": "",
"ModifiedBy": "",
"deleted": "0",
"BookingInterval": "60",
"subdomain": "test-aner-again",
"BookingMinuteBuffer": "60",
"DefaultTaxRate": "0.00",
"DefaultTerms": "",
"AutoCreateInvAppt": "off",
"InvoiceUsingDuration": "off",
"BookingCollectPayment": "off",
"GroupCollectPayment": "off",
"BookingAllowNoProvPref": "1",
"BookingAllowClientReschedule": "0",
"BookingAllowClientCancel": "0",
"GroupAllowClientReschedule": "0",
"GroupAllowClientCancel": "0",
"BookingTimeZoneDefault": "business",
"GroupTimeZoneDefault": "business",
"ContactTimeZoneDefault": "business",
"AcceptPromoCodes": "0",
"AcceptPromoCodesGroup": "0",
"Currency": "usd",
"PaymentProvider": "stripe",
"PaypalEmail": null,
"BookingCancelMinuteBuffer": "0",
"BookingRescheduleMinuteBuffer": "0",
"GroupCancelMinuteBuffer": "0",
"GroupRescheduleMinuteBuffer": "0",
"InvoiceAllowClientPayment": "off",
"ValutecGiftCard": "0",
"ValutecClientKey": "",
"ValutecTerminalId": "",
"DefaultSchedType": "APP",
"Hide": "N",
"BookGeoLocation": "1",
"GroupGeoLocation": "1",
"AuthorizeNetClientKey": "",
"AuthorizeNetApiLoginId": "",
"AuthorizeNetTransactionKey": "",
"MailchimpApiKey": "",
"ValutecTermialId": null,
"BookingAllowCarting": "0",
"GroupAllowCarting": "0"
},
{
"ID": "6077",
"BusinessName": "Test - Aner Again",
"BusinessPhone": "(091)823-4689",
"PhotoLogo": "blank_logo.jpg",
"BusinessWebsite": "",
"LocationName": "Branch 2",
"Street": "",
"City": "Virginia Beach",
"State": "VA",
"Zipcode": "23456",
"Rem": "-",
"Country": "US",
"Timezone": "America/New_York",
"NoAdd": "Y",
"UseMiniSite": "Y",
"GoogleCalActivate": "N",
"MondayIn": "08:00",
"TuesdayIn": "08:00",
"WednesdayIn": "08:00",
"ThursdayIn": "08:00",
"FridayIn": "08:00",
"SaturdayIn": "08:00",
"SundayIn": "08:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"AcctLnkID": "4088",
"AccountEmailAdd": "",
"CalStart": "1381",
"CalEnd": "1426",
"status": "",
"ExStat": "N",
"InfoStat": "",
"LastActivity": "",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "N",
"sunAvailability": "N",
"last_modified": "2018-10-03 19:15:51",
"CreatedBy": "",
"ModifiedBy": "",
"deleted": "0",
"BookingInterval": "60",
"subdomain": "test-aner-again-branch-2",
"BookingMinuteBuffer": "60",
"DefaultTaxRate": "0.00",
"DefaultTerms": "",
"AutoCreateInvAppt": "off",
"InvoiceUsingDuration": "off",
"BookingCollectPayment": "off",
"GroupCollectPayment": "off",
"BookingAllowNoProvPref": "1",
"BookingAllowClientReschedule": "0",
"BookingAllowClientCancel": "0",
"GroupAllowClientReschedule": "0",
"GroupAllowClientCancel": "0",
"BookingTimeZoneDefault": "business",
"GroupTimeZoneDefault": "business",
"ContactTimeZoneDefault": "business",
"AcceptPromoCodes": "0",
"AcceptPromoCodesGroup": "0",
"Currency": "usd",
"PaymentProvider": "stripe",
"PaypalEmail": null,
"BookingCancelMinuteBuffer": "0",
"BookingRescheduleMinuteBuffer": "0",
"GroupCancelMinuteBuffer": "0",
"GroupRescheduleMinuteBuffer": "0",
"InvoiceAllowClientPayment": "off",
"ValutecGiftCard": "0",
"ValutecClientKey": "",
"ValutecTerminalId": "",
"DefaultSchedType": "APP",
"Hide": "N",
"BookGeoLocation": "1",
"GroupGeoLocation": "1",
"AuthorizeNetClientKey": "",
"AuthorizeNetApiLoginId": "",
"AuthorizeNetTransactionKey": "",
"MailchimpApiKey": "",
"ValutecTermialId": null,
"BookingAllowCarting": "0",
"GroupAllowCarting": "0"
}
]
}
Get A Location by ID
URL: https://gigabook.com/api/locations/get
Methods: GET
| Parameters | Required/Optional | Description |
| ID | Required | Location ID in ‘string’ |
Request:
ID=6077
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "6077",
"BusinessName": "Test - Aner Again",
"BusinessPhone": "(091)823-4689",
"PhotoLogo": "blank_logo.jpg",
"BusinessWebsite": "",
"LocationName": "Branch 2",
"Street": "",
"City": "Virginia Beach",
"State": "VA",
"Zipcode": "23456",
"Rem": "-",
"Country": "US",
"Timezone": "America/New_York",
"NoAdd": "Y",
"UseMiniSite": "Y",
"GoogleCalActivate": "N",
"MondayIn": "08:00",
"TuesdayIn": "08:00",
"WednesdayIn": "08:00",
"ThursdayIn": "08:00",
"FridayIn": "08:00",
"SaturdayIn": "08:00",
"SundayIn": "08:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"AcctLnkID": "4088",
"AccountEmailAdd": "",
"CalStart": "1381",
"CalEnd": "1426",
"status": "",
"ExStat": "N",
"InfoStat": "",
"LastActivity": "",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "N",
"sunAvailability": "N",
"last_modified": "2018-10-03 19:15:51",
"CreatedBy": "",
"ModifiedBy": "",
"deleted": "0",
"BookingInterval": "60",
"BookingMinuteBuffer": "60",
"subdomain": "test-aner-again-branch-2",
"DefaultTerms": "",
"DefaultTaxRate": "0.00",
"AutoCreateInvAppt": "off",
"InvoiceUsingDuration": "off",
"BookingCollectPayment": "off",
"GroupCollectPayment": "off",
"BookingAllowNoProvPref": "1",
"BookingAllowClientReschedule": "0",
"BookingAllowClientCancel": "0",
"GroupAllowClientReschedule": "0",
"GroupAllowClientCancel": "0",
"BookingTimeZoneDefault": "business",
"GroupTimeZoneDefault": "business",
"ContactTimeZoneDefault": "business",
"AcceptPromoCodes": "0",
"AcceptPromoCodesGroup": "0",
"Currency": "usd",
"PaymentProvider": "stripe",
"PaypalEmail": null,
"AuthorizeNetClientKey": "",
"AuthorizeNetApiLoginId": "",
"AuthorizeNetTransactionKey": "",
"MailchimpApiKey": "",
"BookingCancelMinuteBuffer": "0",
"BookingRescheduleMinuteBuffer": "0",
"GroupCancelMinuteBuffer": "0",
"GroupRescheduleMinuteBuffer": "0",
"InvoiceAllowClientPayment": "off",
"ValutecGiftCard": "0",
"ValutecClientKey": "",
"ValutecTerminalId": "",
"DefaultSchedType": "APP",
"ValutecTermialId": null,
"Hide": "N",
"BookingAllowCarting": "0",
"GroupAllowCarting": "0",
"BookGeoLocation": "1",
"GroupGeoLocation": "1"
}
}
Add A Location
URL: https://gigabook.com/api/locations/add
Methods: POST
| Parameters | Required/Optional | Description |
| LocationName | Required | String |
| LocationPhone | Optional | String |
| LocationWebsite | Optional | String |
| Street | Optional | String |
| City | Required | String |
| State | Optional | String |
| Zipcode | Optional | String |
| Country | Optional | String. ISO 3166-1 Alpha 2 |
| Timezone | Optional | String. Timezone format |
| NoAdd | Optional | String in 'on/off' type |
| Currency | Optional | Numeric |
| Currency | Optional | Numeric |
| Provider | Optional | Array of Provider ID |
| ImageData | Optional | Base64 Encoded Image |
Example
Request:
JSON
{
"LocationName": "Avenir Branch",
"LocationPhone": "639191234567",
"LocationWebsite": "http://www.avenirbranch.com",
"Street": "Archbishop Reyes Ave",
"City": "Cebu",
"State": "Cebu",
"ZipCode": "6000",
"Country": "US",
"Timezone": "America/New_York",
"NoAdd": "on",
"Currency": "usd",
"imagedata": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAbsAAAGxCAYAAAD78hh4AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAP+lSURBVHhe7H0FeBzX1XbK7de/DF+/lNOmdZumTVMKNdQwNcxMDccBJ3Fsx8zMTLLAssVgWZZlWczMjCvm1Yql9z/nzN7VaL2SZVlKZHfOPueZy/fcuzPnnXNpLjh+/DgMMsgggwwy6HwmA+wMMsgggww67+kUsPve975nsMEGG2ywwecFK4xzCHYGGWSQQQYZdD6QAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgYZZJBBBp33ZICdQQYZZJBB5z0ZYGeQQQYZZNB5TwbYGWSQQQYZdN6TAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgYZZJBBBp33ZICdQQYZZJBB5z0ZYGeQQQYZZNB5TwbYGWSQQQYZdN6TAXYGGWSQQQad92SAnUEGGWSQQec9GWBnkEEGGWTQeU8G2BlkkEEGGXTekwF2BhlkkEEGnfdkgJ1BBhlkkEHnPRlgZ5BBBhlk0HlPBtgZZJBBBhl03pMBdgZNGqWvvRUXXXTRiHzJ5Vfhnte34UR5tzWHHcUvxbX6PPdtQ6E1anTqRnncfix59h5c8cdp……… “
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "6085",
"BusinessName": "Test - Aner Again",
"BusinessPhone": "639191234567",
"PhotoLogo": "6085_logo.png",
"BusinessWebsite": "http://www.avenirbranch.com",
"LocationName": "Avenir Branch",
"Street": "Archbishop Reyes Ave",
"City": "Cebu",
"State": "Cebu",
"Zipcode": "6000",
"Rem": "-",
"Country": "US",
"Timezone": "America/New_York",
"NoAdd": "N",
"UseMiniSite": "Y",
"GoogleCalActivate": "N",
"MondayIn": "08:00",
"TuesdayIn": "08:00",
"WednesdayIn": "08:00",
"ThursdayIn": "08:00",
"FridayIn": "08:00",
"SaturdayIn": "08:00",
"SundayIn": "08:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"AcctLnkID": "4088",
"AccountEmailAdd": "",
"CalStart": "1381",
"CalEnd": "1426",
"status": "",
"ExStat": "N",
"InfoStat": "",
"LastActivity": "",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "N",
"sunAvailability": "N",
"last_modified": "2018-10-05 15:13:03",
"CreatedBy": "",
"ModifiedBy": "",
"deleted": "0",
"BookingInterval": "60",
"BookingMinuteBuffer": "60",
"subdomain": "test-aner-again-avenir-branch",
"DefaultTerms": "",
"DefaultTaxRate": "0.00",
"AutoCreateInvAppt": "off",
"InvoiceUsingDuration": "off",
"BookingCollectPayment": "off",
"GroupCollectPayment": "off",
"BookingAllowNoProvPref": "1",
"BookingAllowClientReschedule": "0",
"BookingAllowClientCancel": "0",
"GroupAllowClientReschedule": "0",
"GroupAllowClientCancel": "0",
"BookingTimeZoneDefault": "business",
"GroupTimeZoneDefault": "business",
"ContactTimeZoneDefault": "business",
"AcceptPromoCodes": "0",
"AcceptPromoCodesGroup": "0",
"Currency": "usd",
"PaymentProvider": "stripe",
"PaypalEmail": null,
"AuthorizeNetClientKey": "",
"AuthorizeNetApiLoginId": "",
"AuthorizeNetTransactionKey": "",
"MailchimpApiKey": "",
"BookingCancelMinuteBuffer": "0",
"BookingRescheduleMinuteBuffer": "0",
"GroupCancelMinuteBuffer": "0",
"GroupRescheduleMinuteBuffer": "0",
"InvoiceAllowClientPayment": "off",
"ValutecGiftCard": "0",
"ValutecClientKey": "",
"ValutecTerminalId": "",
"DefaultSchedType": "APP",
"ValutecTermialId": null,
"Hide": "N",
"BookingAllowCarting": "0",
"GroupAllowCarting": "0",
"BookGeoLocation": "1",
"GroupGeoLocation": "1"
}
}
Update A Location
URL: https://gigabook.com/api/locations/update
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Location ID in 'string' |
| LocationName | Optional | String |
| LocationPhone | Optional | String |
| LocationWebsite | Optional | String |
| Street | Optional | String |
| City | Required | String |
| State | Optional | String |
| Zipcode | Optional | String |
| Country | Optional | String. ISO 3166-1 Alpha 2 |
| Timezone | Optional | String. Timezone format |
| NoAdd | Optional | String in 'on/off' type |
| Currency | Optional | Numeric |
| Currency | Optional | Numeric |
| Provider | Optional | Array of Provider ID |
| ImageData | Optional | Base64 Encoded Image |
Request:
JSON
{
"ID": "6085",
"LocationName": "Archbishop Reyes Branch",
"LocationPhone": "639191234567",
"LocationWebsite": "http://www.archbishiopreyesbranch.com",
"Street": "Archbishop Reyes",
"City": "Manila",
"State": "Manila",
"ZipCode": "6000",
"Country": "US",
"Timezone": "America/New_York",
"NoAdd": "off",
"Currency": "php"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"ID": "6085",
"BusinessName": "Test - Aner Again",
"BusinessPhone": "639191234567",
"PhotoLogo": "6085_logo.png",
"BusinessWebsite": "http://www.archbishiopreyesbranch.com",
"LocationName": "Archbishop Reyes Branch",
"Street": "Archbishop Reyes",
"City": "Manila",
"State": "Manila",
"Zipcode": "6000",
"Rem": "-",
"Country": "US",
"Timezone": "America/New_York",
"NoAdd": "Y",
"UseMiniSite": "Y",
"GoogleCalActivate": "N",
"MondayIn": "08:00",
"TuesdayIn": "08:00",
"WednesdayIn": "08:00",
"ThursdayIn": "08:00",
"FridayIn": "08:00",
"SaturdayIn": "08:00",
"SundayIn": "08:00",
"MondayOut": "17:00",
"TuesdayOut": "17:00",
"WednesdayOut": "17:00",
"ThursdayOut": "17:00",
"FridayOut": "17:00",
"SaturdayOut": "17:00",
"SundayOut": "17:00",
"AcctLnkID": "4088",
"AccountEmailAdd": "",
"CalStart": "1381",
"CalEnd": "1426",
"status": "",
"ExStat": "N",
"InfoStat": "",
"LastActivity": "",
"monAvailability": "Y",
"tueAvailability": "Y",
"wedAvailability": "Y",
"thuAvailability": "Y",
"friAvailability": "Y",
"satAvailability": "N",
"sunAvailability": "N",
"last_modified": "2018-10-05 15:44:43",
"CreatedBy": "",
"ModifiedBy": "",
"deleted": "0",
"BookingInterval": "60",
"BookingMinuteBuffer": "60",
"subdomain": "test-aner-again-archbishop-reyes-branch",
"DefaultTerms": "",
"DefaultTaxRate": "0.00",
"AutoCreateInvAppt": "off",
"InvoiceUsingDuration": "off",
"BookingCollectPayment": "off",
"GroupCollectPayment": "off",
"BookingAllowNoProvPref": "1",
"BookingAllowClientReschedule": "0",
"BookingAllowClientCancel": "0",
"GroupAllowClientReschedule": "0",
"GroupAllowClientCancel": "0",
"BookingTimeZoneDefault": "business",
"GroupTimeZoneDefault": "business",
"ContactTimeZoneDefault": "business",
"AcceptPromoCodes": "0",
"AcceptPromoCodesGroup": "0",
"Currency": "php",
"PaymentProvider": "stripe",
"PaypalEmail": null,
"AuthorizeNetClientKey": "",
"AuthorizeNetApiLoginId": "",
"AuthorizeNetTransactionKey": "",
"MailchimpApiKey": "",
"BookingCancelMinuteBuffer": "0",
"BookingRescheduleMinuteBuffer": "0",
"GroupCancelMinuteBuffer": "0",
"GroupRescheduleMinuteBuffer": "0",
"InvoiceAllowClientPayment": "off",
"ValutecGiftCard": "0",
"ValutecClientKey": "",
"ValutecTerminalId": "",
"DefaultSchedType": "APP",
"ValutecTermialId": null,
"Hide": "N",
"BookingAllowCarting": "0",
"GroupAllowCarting": "0",
"BookGeoLocation": "1",
"GroupGeoLocation": "1"
}
}
Delete A Location
URL: https://gigabook.com/api/locations/delete
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Location ID in ‘string’ |
Example
Request:
"ID": "6084"
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "6084"
}
}
Restore A Service
URL: https://gigabook.com/api/services/restore
Methods: POST
| Parameters | Required/Optional | Description |
| ID | Required | Location ID in 'string' |
Example
Request:
JSON
{
"ID": "6084"
}
Response:
JSON
{
"success": true,
"error": false,
"error_message": "",
"data": {
"id": "6084"
}
}
Zapier Integration
Connect Gigabook to hundreds of other apps with Zapier
Zapier lets you connect Gigabook to 1,000+ other web services. Automated connections called Zaps, set up in minutes with no coding, can automate your day-to-day tasks and build workflows between apps that otherwise wouldn't be possible.
Each Zap has one app as the **Trigger**, where your information comes from and which causes one or more **Actions** in other apps, where your data gets sent automatically.
Getting Started with Zapier
Sign up for a free Zapier account, from there you can jump right in. To help you hit the ground running, here are some popular pre-made Zaps.
How do I connect GigaBook to Zapier?
- Log in to your Zapier account or create a new account.
- Navigate to "Connected Accounts" from the top menu bar.
- Now click on "Connect new account" and search for "GigaBook"
- Use your credentials to connect your GigaBook account to Zapier.
- Once that's done you can start creating an automation! Use a pre-made Zap or create your own with the Zap Editor. Creating a Zap requires no coding knowledge and you'll be walked step-by-step through the setup.
- Need inspiration? See everything that's possible with GigaBook and Zapier.
