This call shows all current routing Workstate Sets and associated values.

A WorkState Set is multiple Workstates arranged together and set on the Routing Profile, Administration > Interaction Admin > Routing Profiles.
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": 5,
  "items": [
    {
      "id": 5,
      "name": "Support Tier I",
      "description": null,
      "workstates": [
        {
          "id": 1
        },
        {
          "id": 2
        },
        {
          "id": 1003
        },
        {
          "id": 1004
        },
        {
          "id": 4
        },
        {
          "id": 3
        }
      ],
      "routingProfiles": [
        {
          "id": 15
        },
        {
          "id": 16
        },
        {
          "id": 17
        }
      ]
    },
    {
      "id": 8,
      "name": "Test",
      "description": null,
      "workstates": [
        {
          "id": 1
        },
        {
          "id": 2
        },
        {
          "id": 3
        },
        {
          "id": 1004
        },
        {
          "id": 4
        }
      ],
      "routingProfiles": [
        {
          "id": 13
        }
      ]
    },
    {
      "id": 7,
      "name": "TEST",
      "description": null,
      "workstates": [
        {
          "id": 1
        },
        {
          "id": 2
        },
        {
          "id": 3
        },
        {
          "id": 1003
        },
        {
          "id": 1004
        },
        {
          "id": 4
        }
      ],
      "routingProfiles": []
    },
    {
      "id": 9,
      "name": "Test 2",
      "description": null,
      "workstates": [
        {
          "id": 1
        },
        {
          "id": 2
        },
        {
          "id": 3
        },
        {
          "id": 1003
        },
        {
          "id": 4
        }
      ],
      "routingProfiles": []
    },
    {
      "id": 2,
      "name": "Workstates",
      "description": null,
      "workstates": [
        {
          "id": 4
        },
        {
          "id": 1
        },
        {
          "id": 2
        },
        {
          "id": 1003
        },
        {
          "id": 1005
        },
        {
          "id": 3
        }
      ],
      "routingProfiles": [
        {
          "id": 6
        },
        {
          "id": 7
        },
        {
          "id": 10
        },
        {
          "id": 11
        },
        {
          "id": 12
        },
        {
          "id": 14
        },
        {
          "id": 18
        }
      ]
    }
  ]
}