Get User Details

GET

https://platform-api.convirza.com/v3/users/{id}

Users

Last modified:2026-04-03 14:27:57

Fetches the complete profile and configuration for a single user by their unique numeric ID.

Returned data

Identity: first name, last name, email address, external user ID.

Role and permissions: role name, audio access flag, scorecard assignment.

Group assignment: the organizational unit the user belongs to, plus parent group and billing account.

Call routing: agent ring-to number and agent code.

Account access: number of groups the user can access, number of reports assigned.

Status and timestamps: active/inactive status, creation date.

Validation
The id path parameter must be a positive integer. Non-numeric values, zero, and negative numbers are rejected with 400.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Successfully retrieved user details

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/users/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "ct_user_id": 12345,
        "username": "john.doe@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "user_ext_id": "EXT-001",
        "ct_user_ou_id": 1001,
        "role_id": 2,
        "role_name": "Standard",
        "user_status": "active",
        "score_call": false,
        "access_audio": true,
        "aliases": null,
        "timezone": "America/New_York",
        "agent_ring_to": "+1234567890",
        "agent_code": 10,
        "user_created": "2026-01-15T10:30:00Z",
        "user_modified": "2026-02-20T14:25:00Z"
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

List Users

Update User