This call shows all current routing Workstates and associated values.

Administration > Interaction Admin > Workstate Sets.
Authentication required, please visit this page for Authentication How To.

Parameters

TenantID - How your specific customer instance is identified, this will be a number. Find this in the app Help (?) icon > MotionCX Voice > Tenant:
SkipCount - This is where the list starts. Ex a value of "3" will have the list start from result 4.
MaxResultCount - This will limit the total number of results shown.
Sorting - This allows parsing of the list by the variables in the return.
Search - Search for particular parameter values in the return.
It is recommended advanced filter object be done outside of the API document for best results.

Responses available:

200
401
403

Example return:

{
  "totalCount": 6,
  "items": [
    {
      "id": 1,
      "name": "Available",
      "description": "",
      "color": "#1dc9b7",
      "productive": true,
      "isDefault": true,
      "isHiddenForAgent": false,
      "routingProfiles": [
        {
          "id": 7
        },
        {
          "id": 10
        },
        {
          "id": 11
        }
      ],
      "workstateSets": [
        {
          "id": 2
        },
        {
          "id": 5
        },
        {
          "id": 7
        },
        {
          "id": 8
        },
        {
          "id": 9
        }
      ]
    },
    {
      "id": 2,
      "name": "Unavailable",
      "description": "",
      "color": "#ffb822",
      "productive": false,
      "isDefault": true,
      "isHiddenForAgent": false,
      "routingProfiles": [
        {
          "id": 6
        },
        {
          "id": 12
        },
        {
          "id": 13
        },
        {
          "id": 15
        },
        {
          "id": 16
        },
        {
          "id": 17
        },
        {
          "id": 18
        }
      ],
      "workstateSets": [
        {
          "id": 2
        },
        {
          "id": 5
        },
        {
          "id": 7
        },
        {
          "id": 8
        },
        {
          "id": 9
        }
      ]
    },
    {
      "id": 3,
      "name": "Logged Out",
      "description": "",
      "color": "#fd397a",
      "productive": false,
      "isDefault": true,
      "isHiddenForAgent": false,
      "routingProfiles": [],
      "workstateSets": [
        {
          "id": 2
        },
        {
          "id": 5
        },
        {
          "id": 7
        },
        {
          "id": 8
        },
        {
          "id": 9
        }
      ]
    },
    {
      "id": 4,
      "name": "ACW",
      "description": "",
      "color": "#ffb822",
      "productive": true,
      "isDefault": true,
      "isHiddenForAgent": true,
      "routingProfiles": [],
      "workstateSets": [
        {
          "id": 2
        },
        {
          "id": 5
        },
        {
          "id": 7
        },
        {
          "id": 8
        },
        {
          "id": 9
        }
      ]
    },
    {
      "id": 1003,
      "name": "Break",
      "description": "Lunches & Breaks",
      "color": "#0097fb",
      "productive": false,
      "isDefault": null,
      "isHiddenForAgent": null,
      "routingProfiles": [
        {
          "id": 14
        }
      ],
      "workstateSets": [
        {
          "id": 2
        },
        {
          "id": 5
        },
        {
          "id": 7
        },
        {
          "id": 9
        }
      ]
    },
    {
      "id": 1005,
      "name": "Other",
      "description": null,
      "color": "#a300fb",
      "productive": false,
      "isDefault": null,
      "isHiddenForAgent": null,
      "routingProfiles": [],
      "workstateSets": [
        {
          "id": 2
        }
      ]
    }
  ]
}