Stay organized with collectionsSave and categorize content based on your preferences.
User status represents a state that an agent can be in at any time. Each status
(either out-of-the-box or a newly configured status) is represented in a single
object, such as the following:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eUser status represents the current state of an agent, with each status defined by an object.\u003c/p\u003e\n"],["\u003cp\u003eUser statuses can be retrieved via a GET request to the specified endpoint: \u003ccode\u003ehttps://{{subdomain}}.{{domain}}/manager/api/v1/user_statuses\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eEach user status object includes properties such as \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecolor\u003c/code\u003e, and \u003ccode\u003ewfm_id\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe example response shows various predefined statuses like "Available," "Unavailable," "Break," "Meal," "In-call" and "Offline" with their corresponding color and unique identifiers.\u003c/p\u003e\n"],["\u003cp\u003eA successful GET request for user statuses returns a 200 status code.\u003c/p\u003e\n"]]],[],null,["# User status endpoints\n\nUser status represents a state that an agent can be in at any time. Each status\n(either out-of-the-box or a newly configured status) is represented in a single\nobject, such as the following: \n\n [\n {\n \"id\": 0,\n \"wfm_id\": 0,\n \"name\": \"string\",\n \"color\": \"string\"\n }\n ]\n\nUser statuses\n-------------\n\n***Endpoint:*** \n\n Method: GET\n Type: \n URL: https://{{subdomain}}.{{domain}}/manager/api/v1/user_statuses\n\n***More example Requests/Responses:***\n\n### Example request: User statuses\n\n***Body: None***\n\n### Example response: User statuses\n\n [\n {\n \"id\": 0,\n \"name\": \"Available\",\n \"color\": \"green\",\n \"wfm_id\": 11\n },\n {\n \"id\": -1,\n \"name\": \"Unavailable\",\n \"color\": \"red\",\n \"wfm_id\": 12\n },\n {\n \"id\": -2,\n \"name\": \"Break\",\n \"color\": \"yellow\",\n \"wfm_id\": 29\n },\n {\n \"id\": -3,\n \"name\": \"Special Task\",\n \"color\": \"pink\",\n \"wfm_id\": 30\n },\n {\n \"id\": -4,\n \"name\": \"Meal\",\n \"color\": \"brown\",\n \"wfm_id\": 31\n },\n {\n \"id\": -5,\n \"name\": \"Missed Call\",\n \"color\": \"blue_grey\",\n \"wfm_id\": 32\n },\n {\n \"id\": -6,\n \"name\": \"Wrap-up\",\n \"color\": \"purple\",\n \"wfm_id\": 33\n },\n {\n \"id\": -7,\n \"name\": \"In-call\",\n \"color\": \"light_blue\",\n \"wfm_id\": 34\n },\n {\n \"id\": -8,\n \"name\": \"In-chat\",\n \"color\": \"indigo\",\n \"wfm_id\": 35\n },\n {\n \"id\": -10,\n \"name\": \"Offline\",\n \"color\": \"grey\",\n \"wfm_id\": 36\n },\n {\n \"id\": 5,\n \"name\": \"Meal\",\n \"color\": \"green\",\n \"wfm_id\": 45\n }\n ]\n\n***Status Code:*** 200"]]
