Get deleted user

Returns detailed information about a specific deleted user.

The Get deleted user endpoint returns details for a single deleted user.

Requirements: Base URL, Authentication, Error codes

Scope: users.read

What this does

When you send a Get deleted user request with a user ID,

Voiso
returns the user object for that deleted user.

Deleted users include a deleted_at timestamp.

When to use it

  • Retrieve a deleted user after you have their ID from Get list of deleted users
  • Audit a specific user deletion
  • Verify deletion state before removing a user from downstream systems

Prerequisites

  • The user must exist and be deleted in the contact center.
  • You must have access to the user.

Endpoint


GET /api/v4/users/deleted/USER_ID

Path parameters

  • user_id
    The unique identifier of the user (integer).

Examples

Minimal request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/users/deleted/1234" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns a deleted user object.

{
  "user": {
    "id": "1234",
    "name": "Jane Doe",
    "email": "[email protected]",
    "sip_account": "[email protected]",
    "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"
        },
        "value": 5
      }
    ],
    "status": "available",
    "created_at": "2025-11-11T12:00:00.216Z",
    "updated_at": "2025-11-11T12:00:00.216Z",
    "deleted_at": "2025-11-11T12:00:00.216Z"
  }
}

Troubleshooting

401 Unauthorized

What to check:

  • You are sending Authorization: Bearer <contact_center_api_key>.
  • Your Base URL includes the correct {cluster_id}.

Example response:

{ "error": "Unauthorized" }

403 Forbidden

What to check:

  • The API key is valid, but does not have access to this user.

Example response:

{ "error": "Forbidden" }

404 Not found

This usually means the user ID does not exist, is not deleted, or you do not have access to it.

What to check:

Example response:

{ "error": "Not found" }

429 Too many requests

What to do:

  • Reduce request frequency and retry with backoff.

Example response:

{ "error": "Too many requests" }
Path Params
integer
required

The unique identifier of the deleted user.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json