VOvoiso
Users

Get list of users

Changed on

Returns a paginated list of all users in the contact center.

get/api/v4/users

Request

Query parameters

limitinteger

The number of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

namestring
Example:Jane

Filter by user name.

emailstring email
Example:jane.doe@companyname.com

Filter by user email.

sip_accountstring
Example:jane.doe@contactcenter.com

Filter results by SIP account in the format username@domain.

security_access_group_idinteger
Example:3

Filter by security access group.

extensionstring
Example:102

Filter by extension.

caller_idstring
Example:12025550123

Filter by caller ID.

timezonestring
Example:America/New_York

Filter by time zone name.

Response

OK

Example response

{
  "users": [
    {
      "id": 1,
      "name": "Jane Doe",
      "email": "jane.doe@companyname.com",
      "sip_account": "jane.doe@contactcenter.com",
      "extension": "102",
      "caller_id": "12025550123",
      "employee_id": "E-482",
      "timezone": "America/New_York",
      "security_access_group": {
        "id": 3,
        "name": "Boarding"
      },
      "teams": [
        {
          "id": 3,
          "name": "Multilingual Support"
        }
      ],
      "supervised_teams": [
        {
          "id": 3,
          "name": "Multilingual Support"
        }
      ],
      "queues": [
        {
          "id": 1,
          "name": "Technical Support"
        }
      ],
      "supervised_queues": [
        {
          "id": 1,
          "name": "Technical Support"
        }
      ],
      "webrtc_ringtone": {
        "type": "ringtone",
        "name": "Bells (Default)"
      },
      "channels": [
        "voice",
        "chat",
        "whatsapp"
      ],
      "channel_group_capacity": {
        "chat": 5,
        "instant": 3
      },
      "channel_profiles": [
        {
          "id": 12,
          "channel": "whatsapp",
          "identifier": "18885658889",
          "name": "WhatsApp Main (18885658889)"
        }
      ],
      "speech_language": "en",
      "skills": [
        {
          "skill": {
            "id": 1,
            "name": "Sales",
            "created_at": "2026-01-15T10:30:00.123000Z",
            "updated_at": "2026-01-20T14:15:00.456000Z"
          },
          "value": 5
        }
      ],
      "status": "available",
      "created_at": "2025-11-11T12:00:00.216000Z",
      "updated_at": "2025-11-11T12:00:00.216000Z",
      "deleted_at": "2025-11-11T12:00:00.216000Z"
    }
  ],
  "metadata": {
    "total": 100
  }
}

Changes

  • 5a6ea146bd21Revision changes
    • breaking

      for the query request parameter limit, the max was decreased from 1000.00 to 100.00

    • breaking

      the response property // became nullable for the status

    • warning

      added the new cs enum value to the // response property for the response status

    • warning

      added the new hu enum value to the // response property for the response status

    • warning

      added the new ja enum value to the // response property for the response status

    • warning

      added the new lt enum value to the // response property for the response status

    • warning

      added the new lv enum value to the // response property for the response status

    • warning

      added the new ro enum value to the // response property for the response status

    • warning

      added the new sk enum value to the // response property for the response status

    • warning

      added the new tr enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status