Отримати всі відділи

Отримайте список усіх відділів у вашому обліковому записі
Написано Микола
Оновлено 8 місяців тому

Ви можете отримати список усіх відділів у вашому обліковому записі HelpCrunch. Цей метод може бути вам корисний якщо вам потрібно Оновити відповідальний відділ для чату.

➡️ Запит

URL https://api.helpcrunch.com/v1/departments
Метод GET
Headers Authorization: Bearer <your_api_key>

✅ Відповідь на успішний запит

Якщо ваш запит пройшов успішно, ви отримаєте код успішного статусу 200 OK разом із наведеним нижче тілом відповіді.

{
  "data": [
    {
      "id": 542335,
      "name": "string",
      "agents": [
        {
          "id": 542335,
          "name": "string",
          "email": "string",
          "role": "admin"
        }
      ]
    }
  ],
  "meta": {
    "total": 0
  }
}

Ви можете отримати деталі по кожному полю обʼєкту відділу у статті Модель даних відділу.

Як отримати всі відділи

За замовчуванням цей метод повертає лише перші 100 відділів. Щоб отримати інший набір відділів, слід використовувати параметри offset і limit у рядку запиту запиту GET.

Ліміт за замовчуванням становить 100 і він не може бути більшим за це. Зміщення за умовчанням - 0.

Щоб переглянути всі доступні відділи, спершу скористайтеся розділом meta відповіді JSON, щоб отримати загальну кількість відділів (параметр total).

https://api.helpcrunch.com/departments?offset=100&limit=100
https://api.helpcrunch.com/departments?offset=200&limit=100
https://api.helpcrunch.com/departments?offset=300&limit=100
...

Загальний ліміт запитів становить 120 запитів за хвилину.

🛑 Відповіді з помилками

Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді. Детальніше про коди помилок ви можете прочитати за посиланням.

400 Bad Request

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "customer",
      "message": "This value should be of type numeric."
    },
    {
      "code": "filter[0].field",
      "message": "This value should not be blank."
    }
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "unauthorized",
      "message": "Unauthorized"
    }
  ]
}

429 Too Many Requests

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "too_many_requests",
      "message": "Too many requests"
    }
  ]
}
Чи була наша стаття корисною?