Start

Namespaces List


  • HDESDK
  • HDESDKAuth
  • HDESDKDepartments
  • HDESDKRequests
  • HDESDKUser
  • HDESDKComment
  • HDESDKTickets
  • HDESDKKnowledgeBase

Classes List


  • SDKInit
  • Auth
  • Departments
  • Requests
  • Ticket
  • User
  • Comment
  • KnowledgeBase

Authorization

Auth ($user_email, $apikey, $hde_url) - Generates a new access token

@params
  • $user_email - registered user email address
  • $apikey - API user key (You can find it in the user card, keys are visible only to the main administrator)
  • $hde_url - Your HDE system address (example: "https://example.helpdeskeddy.com")
@return
  • $token - Access token string

                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');
                                            
                                        

GetToken() - Return access token for current user

@return
  • $token - Access token string

                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//User authorization
$start->GetToken();
                                            
                                        

Departments

DepartmentListGet() - Get Departments list


                                            
//Initialisation
$start = new HDESDKSDKInit();

//Get Departments list
$start->DepartmentListGet();
                                            
                                        
@return
  • application/json

                                            
{
    "data": {
        {
            "id":1,
            "name":{
                "ru":"Департамент поддержки",
                "en":"Support Department",
                "ua":"Департамент поддержки"
            }
        },{
            "id":2,
            "name":{
                "ru":"Тестивый департамент",
                "en":"Test department",
                "ua":"Тестивый департамент"
        }
    }
}
                                            
                                        

Tickets

TicketGet($options) - Get Ticket data by ticket_id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'id'      => 1
);

//Print request data
print_r($start->TicketGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

TicketsGet($options) - Get Tickets list

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$ options = array (
   'page' => 2,
   'search' => 'John', // Search by orders, string (optional)
   'user_list' => '1,14,22', // Search requests by owner ID string (optional)
   'owner_list' => '1,44,21', // Search for orders by order executor ID, string (optional)
   'status_list' => 'open, closed', // Search for orders by order status ID, string (optional)
   'priority_list' => '1,3', // Search for orders by order priority ID, string (optional)
   'type_list' => '0,1', // Search for orders by order type ID, string (optional)
   'freeze' => '0', // Filter by frozen orders. Value 0 - only active orders, value 1 - only frozen orders, number (optional)
   'type_list' => '0,1', // Search for orders by order type ID, string (optional)
   'deleted' => '0', // Filter by deleted orders. Value 0 - only active orders, value 1 - only deleted orders, number (optional)
   'from_date_created' => '2017-12-31 00:00:00', // Created from, string (optional)
   'to_date_created' => '2017-12-31 00:00:00', // Created date before, string (optional)
   'from_date_updated' => '2017-12-31 00:00:00', // Date modified from, string (optional)
   'to_date_updated' => '2017-12-31 00:00:00', // Date modified to, string (optional)
   'order_by' => 'date_created {desc}' // Sorting orders, can be specified separated by commas. Tickets can be sorted by parameters: date_created, date_updated, viewed_by_staff, viewed_by_client. Sort order {asc} (ascending) and {desc} (descending). Default value: date_created {desc}, string (optional)
)

//Print request data
print_r($start->TicketsGet($options));
                                            
                                        
@return
  • application/json

                                            
{
    "data": {
        "10": {
            "id":10,
            "unique_id":"YWP-43009",
            "date_created":"2017-01-13 12:36:58",
            "date_updated":"2017-01-17 13:36:46",
            "title":"New ticket",
            "source": "email",
            "status_id":"open",
            "priority_id":2,
            "type_id":0,
            "department_id":2,
            "department_name":"u041eu0442u0434u0435u043b u043fu043eu0434u0434u0435u0440u0436u043au0438",
            "owner_id":1,
            "owner_name":"Ivan",
            "owner_lastname":"Petrov",
            "owner_email":"ivan.petrov@example.com",
            "user_id":41,
            "user_name":"John",
            "user_lastname":"Doe",
            "user_email":"john.doe@example.com",
            "cc": [],
            "bcc": [],
            "followers": [],
            "ticket_lock":0,
            "sla_date":"13.01.2017 12:36",
            "freeze_date":"null",
            "freeze":0,
            "deleted":0,
            "viewed_by_staff":1,
            "viewed_by_client":1,
            "rate": "like",
            "rate_comment": "Nice",
            "rate_date": "2017-01-17 13:33:30",
            "custom_fields":[
                {
                    "id":3,
                    "field_type":"textarea",
                    "field_value":"4345"
                },{
                    "id":4,
                    "field_type":"checkbox",
                    "field_value":1
                }
            ]
        },
        "9": {
            "id":9,
            "unique_id":"IQV-84397",
            "date_created":"2016-08-15 17:05:19",
            "date_updated":"2017-01-18 11:44:13",
            "title":"Test ticket",
            "source": "email",
            "status_id":"process",
            "priority_id":3,
            "type_id":1,
            "department_id":2,
            "department_name":"u041eu0442u0434u0435u043b u043fu043eu0434u0434u0435u0440u0436u043au0438",
            "owner_id":1,
            "owner_name":"Ivan",
            "owner_lastname":"Petrov",
            "owner_email":"ivan.petrov@example.com",
            "user_id":41,
            "user_name":"John",
            "user_lastname":"Doe",
            "user_email":"john.doe@example.com",
            "cc": [],
            "bcc": [],
            "followers": [],
            "ticket_lock":0,
            "sla_date":"17.01.2017 16:00",
            "freeze_date":"null",
            "freeze":0,
            "deleted":0,
            "viewed_by_staff":1,
            "viewed_by_client":1,
            "rate": "",
            "rate_comment": "",
            "rate_date": "",
            "custom_fields":[
                {
                    "id":3,
                    "field_type":"textarea",
                    "field_value":"4345"
                },{
                    "id":4,
                    "field_type":"checkbox",
                    "field_value":1
                }
            ]
        },
    }, "pagination": {
        "total":"2",
        "per_page":30,
        "current_page":1,
        "total_pages":1
    }
}
                                            
                                        

TicketCreate($options) - Create a new Ticket

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
'title' => 'Problem with email', // Request title, string (required)
   'description' => 'Problem with email info@example.com', // Request text, string (required)
   'sla_date' => '01 .01.1970 00:00 ', // SLA date and time, date (optional)
   'freeze_date' => '01 .01.1970 00:00 ', // Freeze order until date and time, date (optional)
   'status_id' => 'process', // Request status, string (optional)
   'priority_id' => 1, // priority ID, number (optional)
   'type_id' => 2, // type ID, number (optional)
   'department_id' => 1, // department ID, number (optional)
   'ticket_lock' => false, // Blocking the ticket. true - block the request. false - unblock order, boolean (optional)
   'owner_id' => 1, // artist ID, number (optional)
   'user_id' => 2, // request owner ID, number (optional)
   'user_email' => 'email@example.com', // If the request owner ID is not specified, then the user's e-mail will be used to create the request, if the user does not exist, it will be automatically created, string (optional)
   'cc' => array (), // Copy of the letter, array of mailboxes (optional)
   'bcc' => array (), // Bcc message, array of mailboxes (optional)
   'followers' => array (), // List of users following the request, user must be an employee, array user_id (optional)
   'create_from_user' => 1, // The first response in the request on behalf of the employee - 0, on behalf of the user 1, by default 1, number (optional)
   'custom_fields' => [1 => 3, 2 => 0], // Array of individual request fields, example: custom_fields [field_id] = value, in the case of a hierarchical field, you must specify the level custom_fields [field_id] [level] = value , array (optional)
   'files' => array () // applications, array of files (optional)

)

//Print request data
print_r($start->TicketCreate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

TicketUpdate($options) - Update Ticket data by ticket_id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
'id' => 9, // order ID, number (required)
   'title' => 'Problem with email', // Application name, string (optional)
   'sla_date' => '01 .01.1970 00:00 ', // SLA date and time, date (optional)
   'freeze_date' => '01 .01.1970 00:00 ', // Freeze order until date and time, date (optional)
   'status_id' => 'process', // Request status, string (optional)
   'priority_id' => 1, // priority ID, number (optional)
   'type_id' => 2, // type ID, number (optional)
   'department_id' => 1, // department ID, number (optional)
   'ticket_lock' => false, // Blocking the ticket. true - block the request. false - unblock order, boolean (optional)
   'owner_id' => 1, // artist ID, number (optional)
   'user_id' => 2, // request owner ID, number (optional)
   'cc' => array (), // Copy of the letter, array of mailboxes (optional)
   'bcc' => array (), // Bcc message, array of mailboxes (optional)
   'followers' => array (), // List of users following the request, user must be an employee, array user_id (optional)
   'custom_fields' => [1 => 3, 2 => 0], // Array of individual request fields, example: custom_fields [field_id] = value, in the case of a hierarchical field, you must specify the level custom_fields [field_id] [level] = value , array (optional));

//Print request data
print_r($start->TicketUpdate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

TicketDelete($options) - Delete Ticket by ticket_id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'id' => 1, // order ID, number (required)
    'delete' => true, // false - transferring orders to deleted ones. true - complete removal of the order. Default false, boolean (optional)
);

//Print request data
print_r($start->TicketDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

TicketAnswersGet($options) - Get Ticket Answers history by ticket_id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'ticket_id' => 1, // ticket ID, number (required)
    'page' => 1, // Page number, number (optional)
);

//Print request data
print_r($start->TicketAnswersGet($options));
                                            
                                        
@return
  • application/json

                                            
{
    "data":[
        {
            "ticket_id":9,
            "id":139,
            "user_id":1,
            "text":"post content",
            "date_created":"17:45:00 26.01.2017",
            "date_updated":"17:45:00 26.01.2017",
            "files":[]
        },{
            "ticket_id":9,
            "id":138,
            "user_id":1,
            "text":"1,2,3",
            "date_created":"14:59:00 17.01.2017",
            "date_updated":"14:59:00 17.01.2017",
            "files":[
                {
                    "name":"test.gif",
                    "url":"https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
                    "data_type":"gif"
                },{
                    "name":"test.png",
                    "url":"https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
                    "data_type":"png"
                }
            ]
        },
    ],
    "pagination":{
                "total":85,
                "per_page":30,
                "current_page":1,
                "total_pages":3
    }
}
                                            
                                        

TicketAnswerSet($options) - Add new Answer to Ticket by ticket_id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
'ticket_id' => 1, // ticket ID, number (required)
     'text' => 'Problem with email', // Comment text, line (required)
     'user_id' => 1, // The owner of the comment, if not specified - the owner will be the API user, number (optional)
     'files' => [], // Array of applications, array of files (optional));

//Print request data
print_r($start->TicketAnswerSet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "ticket_id": 9,
    "id": 150,
    "user_id": 1,
    "text": "Problem with email",
    "date_created": "17:02:00 17.01.2017",
    "date_updated": "17:02:00 17.01.2017",
    "files": [
      {
        "name": "test.gif",
        "url": "https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
        "data_type": "gif"
      },
      {
        "name": "test.png",
        "url": "https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
        "data_type": "png"
      }
    ]
  }
}
                                            
                                        

TicketAnswerUpdate($options) - Update Ticket Answer by ticket_id and answer id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
     'ticket_id' => 1, // ticket ID, number (required)
     'id' => 15, // post ID, number (required)
     'text' => 'Problem with email', // Comment text, line (required)
);

//Print request data
print_r($start->TicketAnswerUpdate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "ticket_id": 9,
    "id": 150,
    "user_id": 1,
    "text": "Problem with email",
    "date_created": "17:02:00 17.01.2017",
    "date_updated": "17:02:00 17.01.2017",
    "files": [
      {
        "name": "test.gif",
        "url": "https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
        "data_type": "gif"
      },
      {
        "name": "test.png",
        "url": "https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
        "data_type": "png"
      }
    ]
  }
}
                                            
                                        

TicketAnswerDelete($options) - Delete Ticket Answer by ticket_id and answer id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'ticket_id' => 1, // ticket ID, number (required)
    'id' => 15 // post ID, number (required)
);

//Print request data
print_r($start->TicketAnswerDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "errors": [
    {
      "code": "s-204",
      "title": "No content",
      "details": "Post with id {15} in ticket with id {9} successfully deleted"
    }
  ]
}
                                            
                                        

TicketStatusesListGet() - Get Ticket Statuses List

@params
  •  
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Print request data
print_r($start->TicketStatusesListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": "open",
      "name": {
        "ru": "Открыто",
        "en": "Open",
        "ua": "Открыто"
      }
    },
    {
      "id": "process",
      "name": {
        "ru": "В процессе",
        "en": "In progress",
        "ua": "В процессе"
      }
    },
    {
      "id": "closed",
      "name": {
        "ru": "Выполнено",
        "en": "Closed",
        "ua": "Выполнено"
      }
    }
  ]
}
                                            
                                        

TicketPrioritiesListGet() - Get Ticket Priorities List

@params
  •  
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');


//Print request data
print_r($start->TicketPrioritiesListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 2,
      "name": {
        "ru": "Стандартно",
        "en": "Standard",
        "ua": "Стандартно"
      }
    },
    {
      "id": 3,
      "name": {
        "ru": "Средний",
        "en": "Medium",
        "ua": "Средний"
      }
    },
    {
      "id": 1,
      "name": {
        "ru": "Срочно",
        "en": "Very urgent",
        "ua": "Срочно"
      }
    }
  ]
}
                                            
                                        

TicketTypesListGet() -Get Ticket Types List

                                           
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Print request data
print_r($start->TicketTypesListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 0,
      "name": {
        "ru": "Без типа",
        "en": "Without type",
        "ua": "Без типа"
      }
    },
    {
      "id": 1,
      "name": {
        "ru": "Проблема",
        "en": "Problem",
        "ua": "Проблема"
      }
    },
    {
      "id": 2,
      "name": {
        "ru": "Задание",
        "en": "Task",
        "ua": "Задание"
      }
    },
    {
      "id": 3,
      "name": {
        "ru": "Ошибка",
        "en": "Bug",
        "ua": "Ошибка"
      }
    }
  ]
}
                                            
                                        
 

CustomFieldsListGet() - Get Tickets Custom Fields List

@params
  •  
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');


//Print request data
print_r($start->CustomFieldsListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "2": {
      "id": 2,
      "name": {
        "ru": "Select",
        "en": "Select",
        "ua": "Select"
      },
      "field_type": "select",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        }
      }
    },
    "3": {
      "id": 3,
      "name": {
        "ru": "Date",
        "en": "Date",
        "ua": "Date"
      },
      "field_type": "date",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        }
      }
    },
    "4": {
      "id": 4,
      "name": {
        "ru": "Checkbox",
        "ua": "Checkbox"
      },
      "field_type": "checkbox",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        }
      }
    },
    "5": {
      "id": 5,
      "name": {
        "ru": "Text",
        "en": "Text",
        "ua": "Text"
      },
      "field_type": "text",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": true,
          "required_to_close_ticket": true
        }
      }
    },
    "6": {
      "id": 6,
      "name": {
        "ru": "Textarea",
        "en": "Textarea",
        "ua": "Textarea"
      },
      "field_type": "textarea",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        }
      }
    },
    "7": {
      "id": 7,
      "name": {
        "ru": "Number",
        "en": "Number",
        "ua": "Number"
      },
      "field_type": "number",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        }
      }
    },
    "8": {
      "id": 8,
      "name": {
        "1": {
          "ru": "Related",
          "en": "Related",
          "ua": "Related"
        },
        "2": {
          "ru": "Related 2",
          "en": "Related 2",
          "ua": "Related 2"
        },
        "3": {
          "ru": "Related 3",
          "en": "Related 3",
          "ua": "Related 3"
        },
        "4": {
          "ru": "Related 4",
          "en": "Related 4",
          "ua": "Related 4"
        }
      },
      "field_type": "hierarchy",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": true,
          "required_to_close_ticket": false
        }
      }
    }
  },
  "pagination": {
    "total": 7,
    "per_page": 30,
    "current_page": 1,
    "total_pages": 1
  }
}
                                            
                                        

CustomFieldGet($options) - Get Custom Field

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'id' => 15 // field ID, number (required)
);

//Print request data
print_r($start->CustomFieldGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "2": {
      "id": 2,
      "name": {
        "ru": "Select",
        "en": "Select",
        "ua": "Select"
      },
      "field_type": "select",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        }
      }
    }
  }
}
                                            
                                        

OptionsGet($options) - Get Custom Field Options

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'custom_field_id' => 1, // field ID, number (required)
);

//Print request data
print_r($start->OptionsGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 5,
      "pid": 0,
      "name": {
        "ru": "1",
        "en": "1",
        "ua": "1"
      }
    },
    {
      "id": 6,
      "pid": 0,
      "name": {
        "ru": "2",
        "en": "2",
        "ua": "2"
      }
    },
    {
      "id": 7,
      "pid": 0,
      "name": {
        "ru": "3",
        "en": "3",
        "ua": "3"
      }
    },
    {
      "id": 171,
      "pid": 0,
      "name": {
        "ru": "4",
        "en": "4",
        "ua": "4"
      }
    }
  ],
  "pagination": {
    "total": 4,
    "per_page": 50,
    "current_page": 1,
    "total_pages": 1
  }
}
                                            
                                        

OptionsSet($options) - Set Custom Field Options

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
     'custom_field_id' => 1, // field ID, number (required)
     'options' => {"options": [{"id": "20", "name": {"ru": "update option", "en": "update option", "ua": "update option "}}]} // Add / update options, array (required)
);

//Print request data
print_r($start->OptionsSet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 20,
      "pid": 0,
      "name": {
        "ru": "update option",
        "en": "update option",
        "ua": "update option"
      }
    },
    {
      "id": 233,
      "pid": 0,
      "name": {
        "ru": "new option",
        "en": "new option",
        "ua": "new option"
      }
    },
    {
      "id": 234,
      "pid": 21,
      "name": {
        "ru": "new option",
        "en": "new option",
        "ua": "new option"
      }
    }
  ]
}
                                            
                                        

OptionsDelete($options) - Delete Custom Field Option by custom_field_id and option_id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'custom_field_id' => 1, // field ID, number (required)
    'option_id' => 233 // Option ID, number (required)
);

//Print request data
print_r($start->OptionsDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "errors": [
    {
      "code": "s-204",
      "title": "No content",
      "details": "Option with id {233} successfully deleted"
    }
  ]
}
                                            
                                        

Comments

CommentsGet($options) - Get Comments list by ticket_id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'ticket_id' => 1, // ticket ID, number (required)
    'page' => 1 // Page number, number (optional)
);

//Print request data
print_r($start->CommentsGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

CommentCreate($options) - Add new Comment to Ticket by ticket_id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
     'ticket_id' => 1, // ticket ID, number (required)
     'text' => 'Problem with email', // Comment text, line (required)
     'user_id' => 1, // The owner of the comment, if not specified - the owner will be the API user, number (optional)
     'files' => [], // Array of applications, array of files (optional)
);

//Print request data
print_r($start->CommentCreate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "ticket_id": 9,
    "id": 6,
    "user_id": 1,
    "text": "test",
    "date_created": "18:18:34 05.01.2017",
    "visible": "staff",
    "files": [
      {
        "name": "test.gif",
        "url": "https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
        "data_type": "gif"
      },
      {
        "name": "test.png",
        "url": "https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
        "data_type": "png"
      }
    ]
  }
}
                                            
                                        

CommentUpdate($options) - Update Comment data by ticket_id and comment id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
     'ticket_id' => 1, // ticket ID, number (required)
     'id' => 15, // comment ID, number (required)
     'text' => 'Problem with email', // Comment text, line (required)
);

//Print request data
print_r($start->CommentUpdate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "ticket_id": 9,
    "id": 6,
    "user_id": 1,
    "text": "Problem with email",
    "date_created": "18:18:34 05.01.2017",
    "visible": "staff",
    "files": [
      {
        "name": "test.gif",
        "url": "https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
        "data_type": "gif"
      },
      {
        "name": "test.png",
        "url": "https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
        "data_type": "png"
      }
    ]
  }
}
                                            
                                        

CommentDelete($options) - Delete Comment by ticket_id and comment id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
     'ticket_id' => 1, // ticket ID, number (required)
     'id' => 15 // Comment ID, number (required)
);

//Print request data
print_r($start->CommentDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "errors": [
    {
      "code": "s-204",
      "title": "No content",
      "details": "Comment with id {15} in ticket with id {9} successfully deleted"
    }
  ]
}
                                            
                                        

Users

UserListGet($options) - Get Users list

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
'page' => 1, // Page number, number (optional)
    'search' => 'John Doe', // Search by users, string (optional)
    'group_list' => 1, // Search for users by group ID, number (optional)
    'from_date_created' => '2018-12-31 00:00:00', // Created date from, string (optional)
    'to_date_created' => '2018-12-31 00:00:00', // Created date before, string (optional)
    'from_date_updated' => '2018-12-31 00:00:00', // Date modified from, string (optional)
    'to_date_updated' => '2018-12-31 00:00:00', // Date modified to, string (optional)
    'order_by' => 'name' // Sorting users, can be separated by commas. Users can be sorted by parameters: date_created, date_updated, name. Sort order {asc} (ascending) and {desc} (descending), string (optional)
);

print_r($start->UserListGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 1,
      "date_created": "2019-01-01 00:00:00",
      "date_updated": "2019-01-01 00:00:00",
      "name": "Admin",
      "lastname": "",
      "email": "test@helpdeskeddy.com",
      "phone": "+37129770143",
      "skype": "",
      "website": "",
      "organization": "",
      "status": "active",
      "language": "en",
      "notifications": 0,
      "api_key": "a32858b4-a65e-49ef-a960-0b7e8d5d1e47",
      "group": {
        "id": 2,
        "type": "staff",
        "name": {
          "ru": "Администратор",
          "en": "Administrator",
          "ua": ""
        },
        "disable": 0
      },
      "department": [
        1,
        2
      ],
      "ldap_username": "",
      "custom_fields": [
        {
          "id": 87,
          "field_type": "textarea",
          "field_value": "test"
        },
        {
          "id": 88,
          "field_type": "checkbox",
          "field_value": 1
        }
      ]
    },
    {
      "id": 6,
      "date_created": "2019-01-01 00:00:00",
      "date_updated": "2019-01-01 00:00:00",
      "name": "Test",
      "lastname": "",
      "email": "test@test.lv",
      "phone": "",
      "skype": "",
      "website": "",
      "organization": "",
      "status": "active",
      "language": "en",
      "notifications": 0,
      "api_key": "a43e6bdc-2ff9-483b-8ebf-ea3ade763864",
      "group": {
        "id": 1,
        "type": "user",
        "name": {
          "ru": "Клиент",
          "en": "Client",
          "ua": "Клиент"
        },
        "disable": 0
      },
      "department": [
        1,
        2
      ],
      "ldap_username": "",
      "custom_fields": [
        {
          "id": 87,
          "field_type": "textarea",
          "field_value": "test"
        },
        {
          "id": 88,
          "field_type": "checkbox",
          "field_value": 1
        }
      ]
    }
  ],
  "pagination": {
    "total": 2,
    "per_page": 30,
    "current_page": 1,
    "total_pages": 1
  }
}
                                            
                                        

UserGet($options) - Get User data by id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'id' => 1 // User ID, number (required)
);

//Print request data
print_r($start->UserGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 1,
    "date_created": "2019-01-01 00:00:00",
    "date_updated": "2019-01-01 00:00:00",
    "name": "Admin",
    "lastname": "",
    "email": "test@helpdeskeddy.com",
    "phone": "+37129770143",
    "skype": "",
    "website": "",
    "organization": "",
    "status": "active",
    "language": "en",
    "notifications": 0,
    "api_key": "a32858b4-a65e-49ef-a960-0b7e8d5d1e47",
    "group": {
      "id": 2,
      "type": "staff",
      "name": {
        "ru": "Администратор",
        "en": "Administrator",
        "ua": "Администратор"
      },
      "disable": 0
    },
    "department": [
      1,
      2
    ],
    "ldap_username": "",
    "custom_fields": [
      {
        "id": 87,
        "field_type": "textarea",
        "field_value": "test"
      },
      {
        "id": 88,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}                                   
                                        

UserCreate($options) - Add new User

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'name' => 'John', // Name, string (required)
    'lastname =>' Doe ', // Last name, string (optional)
    'email' => 'info@example.com', // Mail, string (required)
    'phone =>' 37192345678 ', // Phone, string (optional)
    'skype' => '', // Skype, string (optional)
    'website' => 'http://example.com', // Website, string (optional)
    'organization' => 'organization', // Organization. The name of the new organization. If filled - the organiz_id field is ignored, string (optional)
    'organiz_id' => '', // existing organization ID, number (optional)
    'status' => 'test user', // User status. Available statuses: active, inactive, disabled, fired, string (optional)
    'language' => 'en', // User language. All active languages ​​in the system are available, string (optional)
    'notifications' => 1, // Email notifications. 0 - disabled. Available values ​​are 1 and 0, number (optional)
    'group_id => 15, // group ID, number (required)
    'department' => [0 => 1, 1 => 2], // User departments, array (required)
    'password =>' 123456 ', // Password, string (required)
    'custom_fields' => [87 => 'test', 2 => 1] // Array of individual contact fields, example: custom_fields [field_id] = value, in the case of a hierarchical field, you must specify the level custom_fields [field_id] [level] = value, array (optional)
);

//Print request data
print_r($start->UserCreate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 22,
    "date_created": "2019-01-01 00:00:00",
    "date_updated": "2019-01-01 00:00:00",
    "name": "John",
    "lastname": "Doe",
    "email": "info@example.com",
    "phone": "37192345678",
    "skype": "",
    "website": "http://example.com",
    "organization": {
      "id": 8,
      "name": "Organization",
      "domains": "",
      "address": "",
      "phone": "37192345678",
      "email": "info@example.com",
      "web": "http://example.com"
    },
    "status": "active",
    "language": "en",
    "notifications": 0,
    "api_key": "cf780f93-8bd4-460d-8a56-1f6adadb8e46",
    "group": {
      "id": 1,
      "type": "user",
      "name": {
        "ru": "Клиент",
        "en": "Client",
        "ua": "Клиент"
      },
      "disable": 0
    },
    "department": [
      1,
      2
    ],
    "ldap_username": "",
    "custom_fields": [
      {
        "id": 87,
        "field_type": "textarea",
        "field_value": "test"
      },
      {
        "id": 88,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

UserUpdate($options) - Update User data by id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'id' => 22, // user ID, number (required
    'name' => 'John', // Name, string (optional)
    'lastname =>' Doe ', // Last name, string (optional)
    'email' => 'info@example.com', // Mail, string (optional)
    'phone =>' 37192345678 ', // Phone, string (optional)
    'skype' => '', // Skype, string (optional)
    'website' => 'http://example.com', // Website, string (optional)
    'organization' => 'organization', // Organization. The name of the new organization. If filled - the organiz_id field is ignored, string (optional)
    'organiz_id' => '', // existing organization ID, number (optional)
    'status' => 'test user', // User status. Available statuses: active, inactive, disabled, fired, string (optional)
    'language' => 'en', // User language. All active languages ​​in the system are available, string (optional)
    'notifications' => 1, // Email notifications. 0 - disabled. Available values ​​are 1 and 0, number (optional)
    'group_id => 15, // group ID, number (optional)
    'department' => [0 => 1, 1 => 2], // User departments, array (optional)
    'password =>' 123456 ', // Password, string (optional)
    'custom_fields' => [87 => 'test', 2 => 1] // Array of individual contact fields, example: custom_fields [field_id] = value, in the case of a hierarchical field, you must specify the level custom_fields [field_id] [level] = value, array (optional)
);

//Print request data
print_r($start->UserUpdate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 22,
    "date_created": "2019-01-01 00:00:00",
    "date_updated": "2019-01-01 00:00:00",
    "name": "John",
    "lastname": "Doe",
    "email": "info@example.com",
    "phone": "37192345678",
    "skype": "",
    "website": "http://example.com",
    "organization": {
      "id": 8,
      "name": "Organization",
      "domains": "",
      "address": "",
      "phone": "37192345678",
      "email": "info@example.com",
      "web": "http://example.com"
    },
    "status": "active",
    "language": "en",
    "notifications": 0,
    "api_key": "cf780f93-8bd4-460d-8a56-1f6adadb8e46",
    "group": {
      "id": 1,
      "type": "user",
      "name": {
        "ru": "Клиент",
        "en": "Client",
        "ua": "Клиент"
      },
      "disable": 0
    },
    "department": [
      1,
      2
    ],
    "ldap_username": "",
    "custom_fields": [
      {
        "id": 87,
        "field_type": "textarea",
        "field_value": "test"
      },
      {
        "id": 88,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

UserDelete($options) - Delete User data by id

@params
  • $options - options array
                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'id' => 15 // User ID, number (required)
);

//Print request data
print_r($start->UserDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "errors": [
    {
      "code": "s-204",
      "title": "No content",
      "details": "User with id {22} successfully deleted"
    }
  ]
}
                                            
                                        

Knowledge Base

CategoriesListGet($options) - Get Knowledge Base Categories list

@params
  • $options - options array

                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'page' => 1, // Page number, number (optional)
    'public' => false, // Search in public categories, boolean (optional)
    'parent_list' => '1,2,3', // Search for categories by parent categories, separated by commas, string (optional)
    'from_date_created' => '2018-12-31 00:00:00', // Created date from, string (optional)
    'to_date_created' => '2018-12-31 00:00:00', // Created date before, string (optional)
    'from_date_updated' => '2018-12-31 00:00:00', // Date modified from, string (optional)
    'to_date_updated' => '2018-12-31 00:00:00', // Date modified to, string (optional)
    'order_by' => 'position' // Sorting categories, can be separated by commas. Categories can be sorted by parameters: date_created, date_updated, position. Sort order {asc} (ascending) and {desc} (descending). Default value: position {asc}, string (optional)
);

//Print request data
print_r($start->CategoriesListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "1": {
      "id": 1,
      "parent_id": 0,
      "position": 23,
      "date_created": "2017-03-24 15:47:01",
      "date_updated": "2019-03-05 20:19:40",
      "access": "staff",
      "access_by_groups": [
        1,
        3,
        2
      ],
      "title": {
        "ru": "test category 1",
        "en": "test category 1",
        "ua": "test category 1"
      }
    },
    "2": {
      "id": 2,
      "parent_id": 1,
      "position": 21,
      "date_created": "2017-05-29 11:57:24",
      "date_updated": "2018-12-06 15:25:57",
      "access": "user",
      "access_by_groups": [
        3,
        5,
        6,
        7,
        8,
        10,
        11,
        2
      ],
      "title": {
        "ru": "test category 2",
        "en": "test category 2",
        "ua": "test category 2"
      }
    },
    "-1": {
      "id": -1,
      "parent_id": 0,
      "position": 1,
      "date_created": "2015-12-31 23:00:00",
      "date_updated": "2019-01-30 15:54:21",
      "access": "public",
      "access_by_groups": [
        1,
        3,
        2
      ],
      "title": {
        "ru": "Шаблоны",
        "en": "Templates",
        "ua": "Шаблони"
      }
    },
    "-2": {
      "id": -2,
      "parent_id": 0,
      "position": 3,
      "date_created": "2018-01-01 00:00:00",
      "date_updated": "2019-03-16 01:06:45",
      "access": "user",
      "access_by_groups": [
        1,
        3,
        2
      ],
      "title": {
        "ru": "Новости",
        "en": "News",
        "ua": "Новини"
      }
    }
  },
  "pagination": {
    "total": 4,
    "per_page": 30,
    "current_page": 1,
    "total_pages": 1
  }
}                                        
                                        

ArticlesListGet($options) - Get Knowledge Base Articles list

@params
  • $options - options array

                                            
//Initialisation
$start = new HDESDKSDKInit();

//User authorization
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Set options
$options = array(
    'page' => 1, // Page number, number (optional)
    'public' => false, // Search public articles, boolean (optional)
    'category_list' => '1,2,3', // Search articles by category, separated by commas, string (optional)
    'from_date_created' => '2018-12-31 00:00:00', // Created date from, string (optional)
    'to_date_created' => '2018-12-31 00:00:00', // Created date before, string (optional)
    'from_date_updated' => '2018-12-31 00:00:00', // Date modified from, string (optional)
    'to_date_updated' => '2018-12-31 00:00:00', // Date modified to, string (optional)
    'order_by' => 'views' // Sorting articles, can be specified separated by commas. Articles can be sorted by parameters: date_created, date_updated, views, pin. Sort order {asc} (ascending) and {desc} (descending). Default value: date_created {desc}, string (optional)
);

//Print request data
print_r($start->ArticlesListGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "56": {
      "id": 56,
      "date_created": "2018-07-17 15:15:00",
      "date_updated": "2018-07-24 17:12:55",
      "show_me_only": false,
      "access": "public",
      "pin": false,
      "views_count": 130,
      "categories": [
        1
      ],
      "title": {
        "ru": "test article",
        "en": "test article",
        "ua": "test article"
      },
      "tags": {
        "ru": [
          "test",
          "test2",
          "test3"
        ],
        "en": [],
        "ua": []
      },
      "body": {
        "ru": "test body",
        "en": "test body",
        "ua": "test body"
      },
      "files": []
    },
    "57": {
      "id": 57,
      "date_created": "2018-07-17 15:15:00",
      "date_updated": "2018-07-24 17:27:27",
      "show_me_only": false,
      "access": "staff",
      "pin": false,
      "views_count": 43,
      "categories": [
        1,
        2
      ],
      "title": {
        "ru": "test article",
        "en": "test article",
        "ua": "test article"
      },
      "tags": {
        "ru": [
          "режим",
          "серия pro"
        ],
        "en": [],
        "ua": []
      },
      "body": {
        "ru": "test body",
        "en": "test body",
        "ua": "test body"
      },
      "files": []
    },
    "58": {
      "id": 58,
      "date_created": "2018-07-17 15:15:00",
      "date_updated": "2018-07-17 15:15:00",
      "show_me_only": false,
      "access": "user",
      "pin": false,
      "views_count": 3,
      "categories": [
        2
      ],
      "title": {
        "ru": "test article",
        "en": "test article",
        "ua": "test article"
      },
      "tags": {
        "ru": [
          "ретранслятор",
          "ретрансляция",
          "ртр",
          "ри-м",
          "рр"
        ],
        "en": [],
        "ua": []
      },
      "body": {
        "ru": "test body",
        "en": "test body",
        "ua": "test body"
      },
      "files": []
    },
    "60": {
      "id": 60,
      "date_created": "2018-07-24 17:24:00",
      "date_updated": "2019-02-01 18:04:21",
      "show_me_only": false,
      "access": "public",
      "pin": false,
      "views_count": 32,
      "categories": [
        -2,
        2
      ],
      "title": {
        "ru": "test article",
        "en": "test article",
        "ua": "test article"
      },
      "tags": {
        "ru": [],
        "en": [],
        "ua": []
      },
      "body": {
        "ru": "test body",
        "en": "test body",
        "ua": "test body"
      },
      "files": [
        {
          "name": "test.gif",
          "url": "https://домен_системы/ru/knowledge_base/download/60/file/f8bb43e593d867d27c965d38dfec721fbb084cf9",
          "data_type": "gif"
        },
        {
          "name": "test.png",
          "url": "https://домен_системы/ru/knowledge_base/download/60/file/b818daf594dd3b61098cce7fef7954bc0314edd5",
          "data_type": "png"
        }
      ]
    }
  },
  "pagination": {
    "total": 4,
    "per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}