search

Scalla CRM API Reference

Welcome to the Scalla CRM API Documentation. This API allows you to programmatically access and interact with your CRM data using RESTful principles.

15+
Endpoints
security
Secure Auth
speed
High Performance

Getting Started

link Base URL
https://crm.scalla.com/modules/Mobile/api.php
info API Version
v2.0

Current stable release. Mobile compatible API.

support_agent Developer Support

Need help integrating? Contact our API support team.

email api-support@scalla.com

Authentication Flow

Follow these steps to authenticate and make secure requests to the API.

1

Login API Call

Call the / endpoint with your username and password to receive an active _sessionName.

2

Include Tenant ID

Ensure tenant_id is included in every API request payload or URL parameter as required by your client configuration.

3

Add to Headers

Provide the session token via the _sessionName form parameter, or as a Bearer token in the Authorization: Bearer <token> header.

done

Make API Calls

You are now ready to fetch records, list modules, and interact with the CRM!

Response Codes & Error Handling

The API uses standard HTTP status codes to indicate the success or failure of an API request.

400
Bad Request The request was unacceptable, often due to missing a required parameter or invalid formatting.
401
Unauthorized No valid API key or session token provided. Or standard login failed.
404
Not Found The requested resource or endpoint doesn't exist. Often due to wrong spelling or unavailable module.
500
Server Error Something went wrong on our end. Please contact support.

Available Modules (Tags)

Authentication Records Modules Comments Organizations Contacts + much more externally accessed dynamically

Login API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/

Validates user access to the CRM. If access is valid and user has permission to access mobile apps, login will be successful.

Request

security Security: Bearer Auth or Session Based

Parameters

_operation string
required
Operation method to execute
_operation enum

Default: loginAndFetchModules
eg. loginAndFetchModules
username string
required
User name of user
eg. kalpesh.variance@gmail.com
password string
required
Password of user
eg. kalpesh.variance@gmail.com

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
_operation* :
_operation :
username* :
password* :
arrow_drop_down Body 
{
  "_operation": "loginAndFetchModules",
  "username": "kalpesh.variance@gmail.com",
  "password": "kalpesh.variance@gmail.com"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/ \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=loginAndFetchModules' \
  --data 'username=kalpesh.variance@gmail.com' \
  --data 'password=kalpesh.variance@gmail.com'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/";
const payload = new URLSearchParams({
  _operation: "loginAndFetchModules",
  username: "kalpesh.variance@gmail.com",
  password: "kalpesh.variance@gmail.com"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/"
payload = {
    "_operation": "loginAndFetchModules",
    "username": "kalpesh.variance@gmail.com",
    "password": "kalpesh.variance@gmail.com"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/";
$data = [
    "_operation" => "loginAndFetchModules",
    "username" => "kalpesh.variance@gmail.com",
    "password" => "kalpesh.variance@gmail.com"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Forgot Password API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/forgotPassword

Used when a user forgets his password. If details are verified, user will get a mail to registered mail address to create new passwords (valid for 42 hours).

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: forgotPassword
eg. forgotPassword
user_name string
required
Username of user
eg. kalpesh.variance@gmail.com
emailId string
required
Email of user
eg. kalpesh.variance@gmail.com

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
user_name* :
emailId* :
arrow_drop_down Body 
{
  "_operation": "forgotPassword",
  "user_name": "kalpesh.variance@gmail.com",
  "emailId": "kalpesh.variance@gmail.com"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/forgotPassword \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=forgotPassword' \
  --data 'user_name=kalpesh.variance@gmail.com' \
  --data 'emailId=kalpesh.variance@gmail.com'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/forgotPassword";
const payload = new URLSearchParams({
  _operation: "forgotPassword",
  user_name: "kalpesh.variance@gmail.com",
  emailId: "kalpesh.variance@gmail.com"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/forgotPassword"
payload = {
    "_operation": "forgotPassword",
    "user_name": "kalpesh.variance@gmail.com",
    "emailId": "kalpesh.variance@gmail.com"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/forgotPassword";
$data = [
    "_operation" => "forgotPassword",
    "user_name" => "kalpesh.variance@gmail.com",
    "emailId" => "kalpesh.variance@gmail.com"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Logout API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/logout

Used to logout from mobile app and close the session.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: logout
eg. logout

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
arrow_drop_down Body 
{
  "_operation": "logout"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/logout \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=logout'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/logout";
const payload = new URLSearchParams({
  _operation: "logout"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/logout"
payload = {
    "_operation": "logout"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/logout";
$data = [
    "_operation" => "logout"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Delete Records API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/deleteRecords

Used to delete records. Record is a combination of web service id and record id, concatenated with "x".

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: deleteRecords
eg. deleteRecords
record string
required
Record with ws id of module
eg. 12x8797

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
record* :
arrow_drop_down Body 
{
  "_operation": "deleteRecords",
  "record": "12x8797"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/deleteRecords \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=deleteRecords' \
  --data 'record=12x8797'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/deleteRecords";
const payload = new URLSearchParams({
  _operation: "deleteRecords",
  record: "12x8797"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/deleteRecords"
payload = {
    "_operation": "deleteRecords",
    "record": "12x8797"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/deleteRecords";
$data = [
    "_operation" => "deleteRecords",
    "record" => "12x8797"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Save Record API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/saveRecord

Used to Save and Edit records.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: saveRecord
eg. saveRecord
module string
required
Module name
eg. Contacts
values string
required
Add field and value in json
eg. { "firstname" : "vijay", "lastname" : "bhavsar","assigned_user_id":"19x1"}
user_id string
required
User id
eg. 19x1

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
module* :
values* :
user_id* :
arrow_drop_down Body 
{
  "_operation": "saveRecord",
  "module": "Contacts",
  "values": "{ "firstname" : "vijay", "lastname" : "bhavsar","assigned_user_id":"19x1"}",
  "user_id": "19x1"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/saveRecord \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=saveRecord' \
  --data 'module=Contacts' \
  --data 'values={ "firstname" : "vijay", "lastname" : "bhavsar","assigned_user_id":"19x1"}' \
  --data 'user_id=19x1'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/saveRecord";
const payload = new URLSearchParams({
  _operation: "saveRecord",
  module: "Contacts",
  values: "{ "firstname" : "vijay", "lastname" : "bhavsar","assigned_user_id":"19x1"}",
  user_id: "19x1"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/saveRecord"
payload = {
    "_operation": "saveRecord",
    "module": "Contacts",
    "values": "{ "firstname" : "vijay", "lastname" : "bhavsar","assigned_user_id":"19x1"}",
    "user_id": "19x1"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/saveRecord";
$data = [
    "_operation" => "saveRecord",
    "module" => "Contacts",
    "values" => "{ "firstname" : "vijay", "lastname" : "bhavsar","assigned_user_id":"19x1"}",
    "user_id" => "19x1"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Related Records API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/relatedRecords

Used to Fetch list of Widgets of summary tab according to requested module and record.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: RelatedRecords
eg. RelatedRecords
module string
required
Module name
eg. Contacts
record string
required
Record with ws id of module
eg. 12x39

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
module* :
record* :
arrow_drop_down Body 
{
  "_operation": "RelatedRecords",
  "module": "Contacts",
  "record": "12x39"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/relatedRecords \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=RelatedRecords' \
  --data 'module=Contacts' \
  --data 'record=12x39'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedRecords";
const payload = new URLSearchParams({
  _operation: "RelatedRecords",
  module: "Contacts",
  record: "12x39"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedRecords"
payload = {
    "_operation": "RelatedRecords",
    "module": "Contacts",
    "record": "12x39"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedRecords";
$data = [
    "_operation" => "RelatedRecords",
    "module" => "Contacts",
    "record" => "12x39"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

List Module Records API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/listModuleRecords

Used to Fetch list of records according to requested module and filter.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: listModuleRecords
eg. listModuleRecords
module string
required
Name of module
eg. Contacts
filterid integer
required
Id of custom view
eg. 7
index integer
required
No of pages
eg. 1
size integer
required
Size of records
eg. 20

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
module* :
filterid* :
index* :
size* :
arrow_drop_down Body 
{
  "_operation": "listModuleRecords",
  "module": "Contacts",
  "filterid": "7",
  "index": "1",
  "size": "20"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/listModuleRecords \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=listModuleRecords' \
  --data 'module=Contacts' \
  --data 'filterid=7' \
  --data 'index=1' \
  --data 'size=20'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/listModuleRecords";
const payload = new URLSearchParams({
  _operation: "listModuleRecords",
  module: "Contacts",
  filterid: "7",
  index: "1",
  size: "20"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/listModuleRecords"
payload = {
    "_operation": "listModuleRecords",
    "module": "Contacts",
    "filterid": "7",
    "index": "1",
    "size": "20"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/listModuleRecords";
$data = [
    "_operation" => "listModuleRecords",
    "module" => "Contacts",
    "filterid" => "7",
    "index" => "1",
    "size" => "20"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Search List Module Records API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/searchListModuleRecords

Used to search in list of module with requested field and value for search.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: searchListModuleRecords
eg. searchListModuleRecords
module string
required
Name of module
eg. Contacts
filterid integer
required
Id of custom view
eg. 7
index integer
required
No of pages
eg. 1
size integer
required
Size of records
eg. 20
field_name string
required
Name of field
eg. lastname
field_value string
required
Value of field
eg. smith

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
module* :
filterid* :
index* :
size* :
field_name* :
field_value* :
arrow_drop_down Body 
{
  "_operation": "searchListModuleRecords",
  "module": "Contacts",
  "filterid": "7",
  "index": "1",
  "size": "20",
  "field_name": "lastname",
  "field_value": "smith"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/searchListModuleRecords \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=searchListModuleRecords' \
  --data 'module=Contacts' \
  --data 'filterid=7' \
  --data 'index=1' \
  --data 'size=20' \
  --data 'field_name=lastname' \
  --data 'field_value=smith'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/searchListModuleRecords";
const payload = new URLSearchParams({
  _operation: "searchListModuleRecords",
  module: "Contacts",
  filterid: "7",
  index: "1",
  size: "20",
  field_name: "lastname",
  field_value: "smith"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/searchListModuleRecords"
payload = {
    "_operation": "searchListModuleRecords",
    "module": "Contacts",
    "filterid": "7",
    "index": "1",
    "size": "20",
    "field_name": "lastname",
    "field_value": "smith"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/searchListModuleRecords";
$data = [
    "_operation" => "searchListModuleRecords",
    "module" => "Contacts",
    "filterid" => "7",
    "index" => "1",
    "size" => "20",
    "field_name" => "lastname",
    "field_value" => "smith"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Fetch Record With Grouping API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/fetchRecordWithGrouping

Used to get details of DetailView of requested module and record.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: fetchRecordWithGrouping
eg. fetchRecordWithGrouping
record string
required
Record with ws id of module
eg. 12x8740

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
record* :
arrow_drop_down Body 
{
  "_operation": "fetchRecordWithGrouping",
  "record": "12x8740"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/fetchRecordWithGrouping \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=fetchRecordWithGrouping' \
  --data 'record=12x8740'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/fetchRecordWithGrouping";
const payload = new URLSearchParams({
  _operation: "fetchRecordWithGrouping",
  record: "12x8740"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/fetchRecordWithGrouping"
payload = {
    "_operation": "fetchRecordWithGrouping",
    "record": "12x8740"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/fetchRecordWithGrouping";
$data = [
    "_operation" => "fetchRecordWithGrouping",
    "record" => "12x8740"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Fetch Module Filters API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/fetchModuleFilters

Used to Fetch list of Filters according to the requested module.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: fetchModuleFilters
eg. fetchModuleFilters
module string
required
Module Name
eg. Products

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
module* :
arrow_drop_down Body 
{
  "_operation": "fetchModuleFilters",
  "module": "Products"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/fetchModuleFilters \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=fetchModuleFilters' \
  --data 'module=Products'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/fetchModuleFilters";
const payload = new URLSearchParams({
  _operation: "fetchModuleFilters",
  module: "Products"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/fetchModuleFilters"
payload = {
    "_operation": "fetchModuleFilters",
    "module": "Products"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/fetchModuleFilters";
$data = [
    "_operation" => "fetchModuleFilters",
    "module" => "Products"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Describe API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/describe

Used to Fetch all the Active Fields of the module according to the requested module.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: newDescribe
eg. newDescribe
module string
required
Module Name
eg. Contacts

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
module* :
arrow_drop_down Body 
{
  "_operation": "newDescribe",
  "module": "Contacts"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/describe \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=newDescribe' \
  --data 'module=Contacts'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/describe";
const payload = new URLSearchParams({
  _operation: "newDescribe",
  module: "Contacts"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/describe"
payload = {
    "_operation": "newDescribe",
    "module": "Contacts"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/describe";
$data = [
    "_operation" => "newDescribe",
    "module" => "Contacts"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Related Module List API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModuleList

Used to Fetch list of records of related module according to requested source module and related module with record of source module.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: relatedModuleList
eg. relatedModuleList
module string
required
Module name
eg. Contacts
record string
required
Record with ws id of module
eg. 12x39
relatedmodule string
required
Related module name
eg. Products

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
module* :
record* :
relatedmodule* :
arrow_drop_down Body 
{
  "_operation": "relatedModuleList",
  "module": "Contacts",
  "record": "12x39",
  "relatedmodule": "Products"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModuleList \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=relatedModuleList' \
  --data 'module=Contacts' \
  --data 'record=12x39' \
  --data 'relatedmodule=Products'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModuleList";
const payload = new URLSearchParams({
  _operation: "relatedModuleList",
  module: "Contacts",
  record: "12x39",
  relatedmodule: "Products"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModuleList"
payload = {
    "_operation": "relatedModuleList",
    "module": "Contacts",
    "record": "12x39",
    "relatedmodule": "Products"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModuleList";
$data = [
    "_operation" => "relatedModuleList",
    "module" => "Contacts",
    "record" => "12x39",
    "relatedmodule" => "Products"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Related Module API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModule

Used to Fetch list of related module and tab in detail view according to requested module and record.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: relatedModule
eg. relatedModule
module string
required
Name of module
eg. Contacts
record string
required
Record with ws id of module
eg. 12x8740

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
module* :
record* :
arrow_drop_down Body 
{
  "_operation": "relatedModule",
  "module": "Contacts",
  "record": "12x8740"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModule \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=relatedModule' \
  --data 'module=Contacts' \
  --data 'record=12x8740'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModule";
const payload = new URLSearchParams({
  _operation: "relatedModule",
  module: "Contacts",
  record: "12x8740"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModule"
payload = {
    "_operation": "relatedModule",
    "module": "Contacts",
    "record": "12x8740"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/relatedModule";
$data = [
    "_operation" => "relatedModule",
    "module" => "Contacts",
    "record" => "12x8740"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

Add Record Comment API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/addRecordComment

Used to add comments.

rate_review Add Comment Interface Demo

JD
Format notes using plain text. Max 5000 characters.

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: addRecordComment
eg. addRecordComment
values string
required
Add field and value in json
eg. {"related_to":"12x39", "commentcontent":"welcome", "parent_comments":"32x43", "assigned_user_id":"19x1"}

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
values* :
arrow_drop_down Body 
{
  "_operation": "addRecordComment",
  "values": "{"related_to":"12x39", "commentcontent":"welcome", "parent_comments":"32x43", "assigned_user_id":"19x1"}"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/addRecordComment \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=addRecordComment' \
  --data 'values={"related_to":"12x39", "commentcontent":"welcome", "parent_comments":"32x43", "assigned_user_id":"19x1"}'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/addRecordComment";
const payload = new URLSearchParams({
  _operation: "addRecordComment",
  values: "{"related_to":"12x39", "commentcontent":"welcome", "parent_comments":"32x43", "assigned_user_id":"19x1"}"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/addRecordComment"
payload = {
    "_operation": "addRecordComment",
    "values": "{"related_to":"12x39", "commentcontent":"welcome", "parent_comments":"32x43", "assigned_user_id":"19x1"}"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/addRecordComment";
$data = [
    "_operation" => "addRecordComment",
    "values" => "{"related_to":"12x39", "commentcontent":"welcome", "parent_comments":"32x43", "assigned_user_id":"19x1"}"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}

List Record Comment API

POST https://api.scallacrm.co.il/modules/Mobile/api.php/listRecordComment

Used to Fetch list of comments according to requested related record of comment.

forum Comments List UI Example
  • SA
    System Admin 2 hours ago
    This record has been updated after the client meeting. Please review the new attachments.
  • JD
    John Doe Yesterday, 14:30
    Noted, will check the documentation and schedule a follow-up.
chevron_left 1 2 3 chevron_right

Request

security Security: Bearer Auth or Session Based

Parameters

tenant_id string
required
Tenant name identifier
eg. cHJlZml4X3lra2d6MjkwNTIzMDYzNzAy
_operation enum
required

Default: listRecordComment
eg. listRecordComment
record string
required
Record with ws id of module
eg. 12x8202
index integer
required
No of pages
eg. 1
size integer
required
Size of records
eg. 20

Responses

200
400
401
429
500

Body

application/json expand_more
success boolean
Indicates if the request was successful.
Example: true
code integer
Example: 200
message string
Example: successful
result object
The returned data object.
arrow_drop_down Auth
Token :
arrow_drop_down Parameters
tenant_id* :
_operation* :
record* :
index* :
size* :
arrow_drop_down Body 
{
  "_operation": "listRecordComment",
  "record": "12x8202",
  "index": "1",
  "size": "20"
}
Request Sample: 
curl --request POST \
  --url https://api.scallacrm.co.il/modules/Mobile/api.php/listRecordComment \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '_operation=listRecordComment' \
  --data 'record=12x8202' \
  --data 'index=1' \
  --data 'size=20'
const url = "https://api.scallacrm.co.il/modules/Mobile/api.php/listRecordComment";
const payload = new URLSearchParams({
  _operation: "listRecordComment",
  record: "12x8202",
  index: "1",
  size: "20"
});

fetch(url, {
  method: 'POST',
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: payload
})
.then(res => res.json())
.then(json => console.log(json));
import requests

url = "https://api.scallacrm.co.il/modules/Mobile/api.php/listRecordComment"
payload = {
    "_operation": "listRecordComment",
    "record": "12x8202",
    "index": "1",
    "size": "20"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)
print(response.text)
<?php
$url = "https://api.scallacrm.co.il/modules/Mobile/api.php/listRecordComment";
$data = [
    "_operation" => "listRecordComment",
    "record" => "12x8202",
    "index" => "1",
    "size" => "20"
];

$options = [
  "http" => [
    "header"  => "Content-Type: application/x-www-form-urlencoded",
    "method"  => "POST",
    "content" => http_build_query($data)
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump(json_decode($result));
Response Example 
{
  "success": true,
  "code": 200,
  "message": "successfully",
  "result": {
    "id": "12x345",
    "list": []
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 429,
    "message": "Too many requests"
  }
}
Response Example 
{
  "success": false,
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}