Get customers

If you are not an agent, you don't have access to the methods.

Getting agent's customers

Method	`get.customers`
Description	Getting agent's customers
Who has access	Partner

Archive customers are not displayed in the list

Parameters of a request

Title	Type	Required	Description
`access_token`	string	yes	Authentication session key
`limit`	number	no	Returning entries count. Refer to "Paging"
`offset`	number	no	Offset that defines from which number to return the entries' `"limit"`. Default value is "0". Refer to "Paging"
`filter`	object	no	Refer to "Filters"
`fields`	array	no	Refer to "Viewing returning data"
`sort`	array	no	Refer to "Data sorting"

Parameters of a reply

Title	Type	Valid value	Filtering	Sorting	Description
`id`	number		yes		Customer unique ID
`name`	string		yes		Customer name
`description`	string				Description of a customer
`creation_date_time`	iso8601	YYYY-MM-DD hh:mm:ss		yes	Time and date when a customer was created
`status`	enum	`waiting` `active` `manual_lock` `limit_lock` `debt_lock`	yes	yes	Customer status
`status_change_date_time`	iso8601	YYYY-MM-DD hh:mm:ss			Time and date when a status was changed
`monthly_base_limit`	number				Monthly base limit. Value is in costs.
`monthly_base_notify_limit`	number				Threshold value of a monthly base limit. When you reach it, a notification is sent to the email specified in the parameter `"monthly_base_notify_email"`
`monthly_base_notify_emails`	array				Emails used to receive notifications when a monthly base linit is reached
`monthly_calls_limit`	number				Monthly calls limits. Value is in calls count.
`monthly_calls_notify_limit`	number				Threshold value of a monthly calls limit. When you reach it, a notification is sent to the email specified in the parameter `"monthly_calls_notify_email"`
`monthly_calls_notify_emails`	array				Emails used to receive the notifications when a monthly calls limit is reached
`daily_calls_limit`	number				Daily calls limit. Value is in calls count.
`daily_calls_notify_limit`	number				Threshold value of a daily calls limit. When you reach it, a notification is sent to the email specified in the parameter `"daily_calls_notify_email"`
`daily_calls_notify_emails`	array				Emails used to receive the notifications when a daily calls limit is reached
List of customer websites
`sites`	array				List of customer websites
`site_id`	number				Website unique ID
`site_domain_name`	string				Website domain name
Tariff plan
`tariff_plan_id`	number		yes		Tariff plan unique ID
`tariff_plan_name`	string		yes		Tariff plan name

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.customers",
  "params":{
    "access_token":"string",
    "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",
        "description":"string",
        "creation_date_time":"iso8601",
        "status":"enum",
        "status_change_date_time":"iso8601",
        "tariff_plan_id":"number",
        "tariff_plan_name":"string",
        "monthly_base_limit":"number",
        "monthly_base_notify_limit":"number",
        "monthly_base_notify_emails":[
          "item"
        ],
        "monthly_calls_limit":"number",
        "monthly_calls_notify_limit":"number",
        "monthly_calls_notify_emails":[
          "item"
        ],
        "daily_calls_limit":"number",
        "daily_calls_notify_limit":"number",
        "daily_calls_notify_emails":[
          "item"
        ],
        "sites":[
          {
            "site_domain_name":"string",
            "site_id":"number"
          }
        ]
      }
    ]
  }
}

List of returning errors

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