Сотрудники

Получение записей о сотрудниках компании.

Возвращает постраничный список сотрудников указанной компании.

Эндпоинт

GET /api/v1/companies/:company_id/employees

Параметры

Параметр	Тип	Где	Описание
`company_id`	`integer`	path	Уникальный идентификатор компании.
`page`	`integer`	query	Номер страницы (по умолчанию: 1).
`limit`	`integer`	query	Записей на странице (по умолчанию: 100).

Примеры кода

import requests

url = 'https://statsnet.co/api/v1/companies/12345/employees'
headers = {
  'Authorization': 'Bearer sk_live_YOUR_KEY',
  'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers).json()
print(response)

Ответ

Успешный ответ

{
  "employees": [
    {
      "id": 1,
      "identifier": "900101350123",
      "name": "Иванов Иван Иванович",
      "position": "Director",
      "employer_identifier": "302233483",
      "employer_name": "Company Name",
      "employer_jurisdiction": "kz",
      "start_date": "2020-01-15T00:00:00Z",
      "end_date": null,
      "created_at": "2021-01-14T00:06:22.439Z",
      "updated_at": "2021-01-15T13:24:54.248Z"
    }
  ],
  "meta": [
    { "type": "Director", "total": 1 }
  ],
  "total": 1,
  "pagination_total": 1,
  "pagination_offset": 0
}

Обработка ошибок

Ответ с ошибкой

{
  "status": 403,
  "message": "access denied"
}

Эндпоинт также может вернуть {"status": 402, "message": "payment required"}, если подписка отменена или истекла, и {"status": 429, "message": "quota exhausted"}, если квота отчётов тарифа на текущий период исчерпана.