Отримати всіх членів команди

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

Ви можете отримати список усіх операторів свого облікового запису HelpCrunch. Оператори — це облікові записи членів команди, які мають доступ до вашого облікового запису HelpCrunch незалежно від їхніх ролей і дозволів.

Ви можете використовувати цей метод для отримання ID членів команди щоб назначити чи змінити відповідального за чат.

➡️ Запит

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

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

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

{
    "data": [
        {
            "id": 2533,
            "name": "Alex",
            "email": "[email protected]",
            "role": "admin"
        },
        {
            "id": 4761,
            "name": "Nick Grachesku",
            "email": "[email protected]",
            "role": "agent"
        },
        {
            "id": 6694,
            "name": "Lisa",
            "email": "[email protected]",
            "role": "agentChatOnly"
        },
        {
            "id": 6679,
            "name": "Les",
            "email": "[email protected]",
            "role": "superviser"
        }
    ],
  "meta": {
   "total": 5
  }
}

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

Як отримати всіх членів команди

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

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

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

https://api.helpcrunch.com/agents?offset=100&limit=100
https://api.helpcrunch.com/agents?offset=200&limit=100
https://api.helpcrunch.com/agents?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"
    }
  ]
}
Чи була наша стаття корисною?