Retrieves detailed user profiles within the Convoso system based on filtering criteria.
Endpoint:
GET https://api.convoso.com/v1/users/search
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | Your API authentication token. |
| user | string | Yes | Comma delimited list of users for filtering recordings |
| limit | integer | Optional | Maximum number of recordings to return. Default is 20. |
| offset | integer | Optional | Number of recordings to skip for pagination. Default is 0. |
Example Request
GET https://api.convoso.com/v1/users/search?auth_token=YOUR_API_TOKEN&user=john1@gmail.com&limit=20&offset=0
Response Format
{
"success": true,
"data": {
"offset": 0,
"limit": "2",
"total": "641",
"results": {
"11004055": {
"id": 1104055,
"acl_access_profile": 1,
"email": "add_user@example",
"first_name": "add user",
"last_name": "add user",
"user_level": 1,
"queue_override": "USE_CAMPAIGN",
"allow_queue_selection": "1",
"allow_callbacks": "1",
"callback_types_allowed": "1",
"allow_transfers": "1",
"default_blended_selection": "0",
"alter_custdata_override": "Y",
"status": "Y",
"local_gmt": "-8.00",
"allow_blended_campaign": "1",
"notification": "0",
"created_at": "2016-11-17T10:54:21-0800",
"connection_type": "BROWSER",
"extension": [
313777
],
"last_login": "2017-10-12 10:09:30"
}
}
}
} Response Descriptions
Top-Level Data Object
| Field | Type | Description |
|---|---|---|
| offset | integer | The current offset (for pagination). |
| limit | integer | Maximum number of entries returned per page. |
| total | integer | Total number of recordings matching the query. |
| entries | array | List of recording objects. |
User Object
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier for the user. |
| acl_access_profile | integer | ACL access level/profile ID. |
string | Email address of the user. | |
| first_name | string | First name of the user. |
| last_name | string | Last name of the user. |
| user_level | integer | Numeric level (e.g. 1 = agent, higher = admin). |
| queue_override | string | Queue assignment behavior (USE_CAMPAIGN, etc.). |
| allow_queue_selection | string ("1"/"0") | Whether the user can select queues manually. |
| allow_callbacks | string ("1"/"0") | Whether the user can create callbacks. |
| callback_types_allowed | string | Types of callbacks allowed (e.g. "1" = standard). |
| allow_transfers | string ("1"/"0") | Whether the user can transfer calls. |
| default_blended_selection | string ("1"/"0") | Default campaign selection mode. |
| alter_custdata_override | string ("Y"/"N") | Whether the user can edit customer data. |
| status | string ("Y"/"N") | Whether the user is active (Y) or inactive (N). |
| local_gmt | string | Local time zone offset from GMT (e.g., "-8.00"). |
| allow_blended_campaign | string ("1"/"0") | Whether user is allowed in blended campaigns. |
| notification | string ("0"/"1") | Whether notification is enabled. |
| created_at | string (ISO8601) | Timestamp of user creation. |
| connection_type | string | Type of login connection (e.g., "BROWSER"). |
| extension | array of int | Extension numbers assigned to the user. |
| last_login | string or null | Timestamp of the last login (YYYY-MM-DD HH:MM:SS), or null if never. |