Skip to content

Get employee positions

Getting the list of employees positions

Method get.employee_positions
Description Getting the list of employees positions
Who has access Agent, Customer

Parameters of a request

Title Type Required Description
access_token string yes Authentication session key
user_id number no Unique user ID of a customer or an agent who makes request.
Is mandatory for an agent
To get a list of customer users use the method "get.customer_users"
limit number no Number of returning inquiries. Refer to "Paging"
offset number no Offset that defines inquiries from which number to return, "limit" of inquiries. Default value is "0". Refer to "Paging"
filter object no Refer to "Filtering criteria"
fields array no Refer to "Viewing returning data"
sort array no Refer to "Data sorting"

Parameters of a reply

Name Type Filtering Sorting Description
id number yes Unique ID of employee's position
name string yes yes Employee's position title

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.employee_positions",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON reply structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string"
      }
    ]
  }
}

List of returning errors

Refer to "List of errors for methods with the verb get"