API Documentation

Version 2.6.1 | Last Update 15/10/23

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

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 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 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:

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.

Description

Parameter

Appearance

Explanation

Email or Id

string or integer

Required

User

Response:

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

‍

Request sample:

‍

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.

Description

Parameter

Appearance

Explanation

sms/push
Lead’s first name

last_name

Lead’s last name

string

phone

source_fk

first_name

allow_mailing_list

Enum = yes, no

Optional

Case sensitive (Use lower case)

allow_sms

Required

string

Optional

Required

string

Int (location must be connected to business)

Int (number)

string

Enum = yes, no

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

Successful response sample:

Copied to clipboard!


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

‍Request sample:

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

leadId

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

‍

Body Params:

Select the raw option.

Description

Parameter

Appearance

Explanation

true - get staff users | false - get clients

Boolean

staff

Optional

Request sample:

Create purchase (membership)

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

‍

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

Description

Parameter

Appearance

Explanation

users_boxes_id

membership_types_id

string

Required

users_boxes_id

start

string

Required

membership start date (yyyy-mm-dd)

end

string

optional

membership end date (yyyy-mm-dd)

String

id

Required

Successful Response Sample:

{

"statusCode": 200,

"data": {

"id": 741,

"start": "2022-12-13",

"end": "2023-03-12",

"sessions_left": null,

"active": 1

"extra": null

}

‍

Get client purchases

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

phone

string

Optional

Client personal id

required

Optional

string

Required

string

DATE

string

first_name

Optional

Client email

birthdate

Secondary client number

Optional

optional

user status:
active=1 -> Activeactive=0 -> None active

Client number

birthday (yyyy-mm-dd)

INT

email

additional_phone

personal_id

gender

string

Optional

male\female\other

allow_sms

Enum = yes, no

optional

Case sensitive (Use lower case)

allow_mailing_list

Enum = yes, no

optional

Case sensitive (Use lower case)

location_box_fk

active

send_welcome_email

Boolean = true , false

optional

Int (number)

optional

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

phone

Enum = yes, no

Optional

Case sensitive (Use lower case)

Required

Optional

string

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'

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.

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

Int (number) or string when targetableType=user

Required

string

targetableType

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

User

Type

Required

array

Optional

Required

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
}

Get Client Data

API URL:

https://api.arboxapp.com/index.php/api/v2/user/{VALUE}

‍

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.
VALUE on the request can be ID of the user or email address

Successful Response Sample:

‍

{

"statusCode": 200,

"data": {

"id": 494716,

"user_fk": 9,

"box_fk": 8,

"locations_box_fk": 1,

"first_name": "test",

"last_name": "register",

"child": 0,

"birthday": "2222-02-12",

"image_public_id_cloudinary": null,

"employee_id": null,

"gender": "male",

"phone": "0523783352",

"rfid": null,

"additional_phone": "6",

"weight": "100",

"height": "180",

"country": "AO",

"city": "add",

"address": "sda",

"zip": "12321",

"state": "xasd",

"personal_id": "23131231",

"medical_cert": 1,

"epidemic_statement": 1,

"active": 1,

"suspended": 0,

"restricted": 0,

"restricted_time": null,

"has_waiver": 1,

"date_waiver": null,

"has_basics_workshop": 0,

"has_nutrition_counseling": 0,

"has_professional_meeting": 0,

"has_insurance": 0,

"has_changed_property": 0,

"allow_sms": "unknown",

"allow_mailing_list": "yes",

"rivhit_customer_id": "8046",

"union_fk": null,

"sugarwod_id": null,

"source_fk": null,

"status_fk": null,

"lost_reasons_fk": null,

"created_at": "2015-08-17 10:25:29",

"updated_at": "2022-02-16 09:54:50",

"deleted_at": null,

"email": "dagan+9@arboxapp.com",

"age": "199.1",

"full_name": "test register",

"full_path_image_user": "https://arboxassets.s3.eu-central-1.amazonaws.com/icons8-male_user.png"

}

‍

API Documentation

Postman

Error manual

Meaning

Error Code

Description

400

415

500

400

401

401

401

Leads

Get all leads

Get all converted leads

Get all lead statuses

Get all lead sources

Search lead by email or ID

Description

Parameter

Appearance

Explanation

Email or Id

Create lead

Description

Parameter

Appearance

Explanation

sms/pushLead’s first name

last_name

Lead’s last name

phone

source_fk

first_name

allow_mailing_list

Enum = yes, no

Optional

Case sensitive (Use lower case)

allow_sms

Lead’s contact number

email

location_box_fk

status_fk

comment

Successful response sample:

Update lead status

Description

Parameter

Appearance

Explanation

sms/pushLead id

status_fk

Status Id, must be connected to the business

leadId

Successful response sample:

Clients

Get all active clients

Description

Parameter

Appearance

Explanation

true - get staff users | false - get clients

staff

Create purchase (membership)

Description

Parameter

Appearance

Explanation

users_boxes_id

membership_types_id

string

Required

users_boxes_id

start

string

Required

membership start date (yyyy-mm-dd)

end

string

sms/push
Lead’s first name

sms/push
Lead id

user status:
active=1 -> Activeactive=0 -> None active