Cubu Docs
S2S API Guide
S2S API Guide
  • About Cubu Server-to-Server API
  • Accessing the API
  • Agent Impersonation API
    • Call Again
    • Clock-in
    • Clock-out
    • Get Agent Status
    • List Active Cases
    • List Inboxes
    • List Workspaces
    • List Workstations
    • Occupy a Workstation
    • Resolve a Case
    • Select Current Unit
    • Start Processing the Next Case
    • Change Status to Available
    • Change Status to Unavailable
    • Vacate a Workstation
  • Appointments Management API
    • Book Appointment
    • Cancel Appointment
    • List Appointments in Calendar
    • List Calendars of a Service
    • List Vacancies in a Calendar
  • Case Management API
    • Queue Up
  • Customer Management API
    • Create a Customer Record
    • Get Customer Record
    • Update a Customer Record
    • Find a Customer Record
  • Organization API
    • List Back-office tasks
    • List Users
Powered by GitBook
On this page
  • URL
  • Headers
  • Request Body
  • Response
  1. Agent Impersonation API

List Workstations

Lists the workstations in the user's current unit.

This endpoint requires the Agent Impersonator role.

URL

GET: https://[base-url]/{applicationId}/agents/{userId}/workstations

Headers

Authorization: Bearer <accessToken>

Request Body

N/A

Response

Success -> 200

An array of Workstation objects

Sample response:

[
    {
        "workstationId": "3e5edafa-afd4-40a4-8fd0-0f8a780c5c08",
        "workstationName": "Counter 1",
        "description": null,
        "isActive": true,
        "status": "Empty",
        "user": null
    },
    {
        "workstationId": "8725058d-1594-49bd-93b8-325c1d55b6ac",
        "workstationName": "Counter 2",
        "description": null,
        "isActive": true,
        "status": "Empty",
        "user": null
    },
    {
        "workstationId": "85cebfcb-e1ce-4189-835d-08db45771c68",
        "workstationName": "Counter 3",
        "description": null,
        "isActive": true,
        "status": "OccupiedOpen",
        "user": {
            "userId": "accef80a-0491-4865-8f1b-1455f4c08b14",
            "displayName": "John Doe",
            "initials": "JD",
            "picture": "https://.../public/profiles/f1af71e8-3ba4-4034-b4f2-..."
        }
    }
]

No current unit was selected for the user -> 403 (Forbidden)

PreviousList WorkspacesNextOccupy a Workstation

Last updated 8 months ago