API Documentation

Version 2.0 | Last Update 13/09/22

Welcome to Arbox, a business management platform where businesses manage all their daily challenges and interact with their customers. Our mission is to help businesses to operate as best they can with their customers.

The API is part of the Arbox platform and allows developers to programmatically access and update data inside an Arbox account. The API is best for connecting external sources (websites, other applications, integration tools like Zapier) to Arbox.

So before you begin, you need to know:

  • The business’ API key will be provided to each business within the Arbox platform.

  • Please copy the API key from the “Settings” page > “Business Information”

  • location_box_fk parameter, which will be provided upon request to the support team.

  • You can only access the API using the HTTP protocol

Postman

Generating an access token using Postman.

Error Manual

The Arbox Open API returns the following error codes in related cases:

Meaning

Error Code

Description

FAILED
INTERNAL SERVER ERROR
400
415
500
400
The user connected with the API is invalid
One or more of your form values are not valid
INVALID FORM REQUEST
There was a problem with our server. Please try again later.
One or more of the fields are incorrect or invalid
INVALID API USER
NO API KEY
INVALID API KEY
Please provide a valid access token
NOT UNIQUE API KEY
Issued access token, please contact support@arboxapp.com
Please supply an access token
401
401
401

Leads

Get all leads

API URL:
https://api.arboxapp.com/index.php/api/v2/leads

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Response:

  • Array of all leads

Request Sample:

Get All Converted Leads

API URL:
https://api.arboxapp.com/index.php/api/v2/convertedLeads

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Response:

  • Array of all lead that was converted to clients

Request Sample:

Get A

Get All Lead Statuses

API URL:
https://api.arboxapp.com/index.php/api/v2/leadsStatuses

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Response:

  • Array of all lead statuses

Request Sample:

Get A

Get All Lead Sources

API URL:
https://api.arboxapp.com/index.php/api/v2/leadsSources

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Response:

  • Array of all lead sources

Request Sample:

Searc

Search Lead by email or id

API URL:
https://api.arboxapp.com/index.php/api/v2/searchUser

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the raw option.


Response:

  • Array that contains the user and its details, or user not found message if it could not find the user.

Request Sample:

Description

Parameter

Appearance

Explanation

Email or Id
string or integer
Required
User

Create Lead

API URL:
https://api.arboxapp.com/index.php/api/v2/leads

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the form-data option.

Request Sample:

Successful Response Sample:

Copied to clipboard!

{
    "statusCode": 200,
    "data": {
        "id": 53736,
        "first_name": "Ella",
        "last_name": "Fish",
        "phone": 05239348583
        "email": "talky@talk.8200"
    }
}
 

Description

Parameter

Appearance

Explanation

sms/push
Lead’s first name
last_name
Lead’s last name
string
string
phone
source_fk
first_name
allow_mailing_list
Enum = yes, no
Optional
Case sensitive (Use lower case)
allow_sms
Required
Required
string
Optional
Required
string
Int (location must be connected to business)
Int (number)
Int (number)
string
Enum = yes, no
Optional
Optional
Optional
Optional
Lead’s contact email
System number - studio’s place
System number - lead’s status at which it will appear after filling out the form.
System number -
the landing page from which the lead generated.
Any additional parameter can be used here.
Case sensitive (Use lower case)
Required
Lead’s contact number
email
location_box_fk
status_fk
comment

Update Lead Status

API URL:
https://api.arboxapp.com/index.php/api/v2/updateLeadStatus

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the raw option.

Description

Parameter

Appearance

Explanation

sms/push
Lead id
status_fk
Status Id, must be connected to the business
integer
integer
leadId
Required
Required

Successful Response Sample:

Copied to clipboard!

{
   "statusCode": 200,
   "data": {
       "id": 258009,
       "first_name": "Test",
       "last_name": "name",
       "email": "test@gmail.com",
       "phone": "030020032",
       "status_fk": 51
   },
   "extra": null
}
 

Clients

The 12 column grid system to make it easy to align sections across different screen sizes.

Get All Active Clients

API URL:
https://api.arboxapp.com/index.php/api/v2/users

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Response:

  • Array of all active clients

Request Sample:

Get

Get Client Memberships

API URL:
https://api.arboxapp.com/index.php/api/v2/membershipsData

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the raw option.

Description

Parameter

Appearance

Explanation

user id
String
userId
Required

Successful Response Sample:

Copied to clipboard!

{
    "statusCode": 200,
    "data": {
        "id": 146,
        "name": "15 Sessions",
        “type”: “plan”,
        “price”: “300”,
“sessions_left: 2”,
“start”: “2020-01-01”,
“end”: “2021-01-01”,
“active”: 1,
“cancelled” : 0,
“debt” : 100,
“created_at”: “2020-01-01”
    }
}
 

Search Client by email or id

API URL:
https://api.arboxapp.com/index.php/api/v2/searchUser

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the raw option.

Description

Parameter

Appearance

Explanation

Email or Id
string or integer
userId
Required

Response:

  • Array that contains the user and its details, or user not found message if it could not find the user.

Request Sample:

Create Client

API URL: 

https://api.arboxapp.com/index.php/api/v2/user

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the form-data option.

Description

Parameter

Appearance

Explanation

First name
last_name
Last name
string
string
phone
Enum = yes, no
Optional
Case sensitive (Use lower case)
Required
Optional
string
Required
Required
string
Date
Enum = yes, no
first_name
Optional
Contact email
Birthdate
Case sensitive (Use lower case)
Optional
Contact number
email
birthday (yyyy-mm-dd)
allow_sms
allow_mailing_list

Request Sample:


Successful Response Sample:

Copied to clipboard!

{
   "statusCode": 200,
   "data": {
       "id": 3647191
   },
   "extra": null
}
 

Update Client

API URL: 

https://api.arboxapp.com/index.php/api/v2/user

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the form-data option.

Description

Parameter

Appearance

Explanation

First name
last_name
Last name
string
string
phone
Enum = yes, no
Optional
Case sensitive (Use lower case)
Required
Optional
string
Required
Required
INT
Date
Enum = yes, no
first_name
Optional
user status:
active=1 -> Active
active=0 -> None active
Birthdate
Case sensitive (Use lower case)
Optional
Contact number
active
birthday (yyyy-mm-dd)
allow_sms
allow_mailing_list

Request Sample:


Successful Response Sample

Copied to clipboard!

{
   "statusCode": 200,
   "data": {
       "id": 3647191,
       "first_name": "apiUser",
       "last_name": "test",
       "active": 0
   },
   "extra": null
}
 

Client Login Authentication

API URL: 

https://api.arboxapp.com/index.php/api/v2/checkActive

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the form-data option.

Description

Parameter

Appearance

Explanation

Successful Response Sample:

Copied to clipboard!

{
    "statusCode": 200,
    "data": {
        "isActive": true/false
    }
 

Get Schedule

Different grid layouts to use across your site

API URL: 

https://api.arboxapp.com/index.php/api/v2/schedule


Acceptable request type:


Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY


Body Params:

  • Select the raw option.

Description

Parameter

Appearance

Explanation

According to time format
to
According to time format
'dd-mm-YYYY'
or
'mm-dd-YYYY'
'dd-mm-YYYY'
or
'mm-dd-YYYY'
location
Optional
Int, (location must be connected to business)
Required
If
Parameter “from” exists then optional
Required
If
Parameter “to” exists then optional
from
System number - studio’s place

Successful Response Sample:

Copied to clipboard!

{
statusCode:200,
data: Array({
            "coach": “Michael Cohen”,
            "secondCoach":  “Lora Smith”,
            "name": “Yoga for Beginners”,
            "startTime": ״14:00:00,
            "endTime": “15:00:00”,
            "date": ”2020-07-26”,
            "liveLink": Live Link to class, if exists,
            "isCancelled": false,
            "maxMembers": 15,
            "location": Tel Aviv,
            "isTransparent": false
})}
 

Error code list

Name

Integer

Description

DATE RANGE EXCEEDS
The date range is greater than 7 days, please limit your request to up to 7 days
415

Get All Task Types

Boxes for text elements throughout the website, e.g for a section header.

API URL:
https://api.arboxapp.com/index.php/api/v2/tasks

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Response:

  • Array of all task types

Request Sample:

Create Task

Icons used across the website taken from the Prosphor Icon Pack.

API URL: 

https://api.arboxapp.com/index.php/api/v2/tasks

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the raw option.

Description

Parameter

Appearance

Explanation

user/lead /general
taskTypeId
System number of task type
string
Int (number)
targetableId
Int, (location must
be connected to business)
string
Required
Optional
System number - studio’s place filling out the form.
comment
Optional
Optional
Int (number) or string when targetableType=user
Required
Required
string
string
string
boolean
Required
When you want to use your format for a date. (must be Y-m-d or d-m-Y or m-d-Y)
As default, format is due to box location (mm-dd-yyyy or dd-mm-yyyy), you can also use your format, according to the parameter “format”.
Hh:mm or HH:mm A format
Required
Required when targetableType is user or lead,
id or email
dateFormat
reminderDate
reminderTime
locationBoxFk
description

Request Sample:

Successful Response Sample:

Copied to clipboard!

{
   "statusCode": 200,
   "data": {
       "id": 1599744,
       "reminderTime": "2021-08-19 19:30:00",
       "taskType": "Call",
       "description": null,
       "targetableType": null,
       "targetableId": null
   },
   "extra": null
}
 

Send Message

API URL: 

https://api.arboxapp.com/index.php/api/v2/message

Acceptable request type:

Headers:

  • In the KEY field, enter “apiKey”
  • In the VALUE field, enter the business API KEY

Body Params:

  • Select the raw option.


Description

Parameter

Appearance

Explanation

sms/push
/email
Identify
email/phone
/user_id
string
string
User
Type
Required
Required
array
Optional
Required
string
string
boolean
Optional
The message will be sent
subject , for email message
If true, send message to leads, otherwise, to users
Optional
List of users or leads, by user email, id or phone (according to identify field), user must be a member of your business
message
subject
isLead

Request Sample:

Successful Response Sample:

Copied to clipboard!

    {
   "statusCode": 200,
   "data": {
       "type": "sms",
       "message": "Test",
       "users": [
           178695,
           24
       ],
       "sendMessageIsNotAllowed": [24]
   },
   "extra": null
}