You can get a list of all agents for your HelpCrunch account. Agents are the team member accounts that have access to your HelpCrunch account regardless of their roles and permissions.

You may need to use this method in order to get agent/assignee id for Update chat assignee method.

➡️ Request

Read more about authorization header here.

✅ Successful Response

If your request has succeeded, you'll get a 200 OK success status code together with the following response body.

{
    "data": [
        {
            "id": 2533,
            "name": "Alex",
            "email": "alex.wasserman@example.com",
            "role": "admin"
        },
        {
            "id": 4761,
            "name": "Nick Grachesku",
            "email": "nick.grachesku@example.com",
            "role": "agent"
        },
        {
            "id": 6694,
            "name": "Lisa",
            "email": "lisa@example.com",
            "role": "agentChatOnly"
        },
        {
            "id": 6679,
            "name": "Les",
            "email": "les.melnik@example.com",
            "role": "superviser"
        }
    ]
}

You can get details on every Agent Object field in the Agent model article.

🛑 Error Responses

You may get one of the following error status codes and responses. More info on the errors is available here.

401 Unauthorized

{
    "errors": [
        {
            "code": "invalid_token",
            "message": "Invalid token"
        }
    ]
}

429 Too Many Requests

{
    "errors": [
        {
            "code": "too_many_requests",
            "message": "You have exceeded your requests limit"
        }
    ]
}

If you have any questions regarding the REST API, feel free to chat us any time.

👩‍💻 Happy Coding! 👨‍💻