Fetch Single User

Sample Request

This API allows you to fetch details of a single User.

curl --request GET \
     --url https://api-smartflo.tatateleservices.com/v1/user/id \
     --header 'accept: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Path Params)

Variable Name	Description	Data Type
id	ID of the user.	String

Sample Response

{
    "data": {
        "id": "288256",
        "name": "xyz",
        "number": "+91999999999",
        "team_member": {
            "designation": null,
            "email": "[email protected]",
            "login_id": "png4747",
            "status": 1,
            "role": {
                "name": "Admin New",
                "id": 54742
            },
            "is_login_based_calling": true,
            "is_web_login_block": false,
            "users_for_cdr": {
                "type": "all",
                "value": null
            }
        },
        "agent": {
            "id": "0502842370002",
            "intercom": 1002,
            "number": "+919999999999",
            "agent_status": 0,
            "extension": {
                "username": "0602842370077",
                "outbound_block": false
            },
            "sticky_Agent": null,
            "time_group": {
                "id": 23743,
                "name": "TEster OCT NOV"
            },
            "failover_destination": {
                "id": "50757",
                "name": "OFF hours OB",
                "type": "auto_attendant"
            },
            "is_international_outbound_enabled": false
        }
    }
}

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
data[i].id	Id of the user.	integer
data[i].name	Name of the user.	String
data[i].number	Phone number of the user.	String
data[i].team_member.designation	Designation of the team member/user.	String
data[i].team_member.email	Email of the team member/user.	String
data[i].team_member.login_id	Login ID of the team member.	String
data[i].team_member.status	Status of the team member. For example: BLOCK = 0 UNBLOCK = 1	integer
data[i].team_member.role.id	Id of the permission role defined for the user.	integer
data[i].team_member.role.name	Name of the permission role defined for the user.	String
data[i].agent.id	Id of the agent.	integer
data[i].agent.intercom	Intercom of the agent/user.	integer
data[i].agent.number	Number of the agent/user.	String
data[i].agent.agent_status	Status of the agent. For example: Enabled = 0 Blocked = 1 Disabled = 2 Busy = 3 Offline = 4	integer
data[i].agent.extension.username	Username of the extension for the agent/user.	String
data[i].agent.extension.outbound_block	Whether outbound calling is blocked for the user extension or not. For example: true or false.	Boolean
data[i].sticky_Agent.timeout	The call timeout duration for the sticky agent. Note: Value is in seconds.	integer
data[i].sticky_Agent.ring_strategy	The ring strategy name of the department. For example, Order By.	String
data[i].sticky_Agent.alternate_numbers	The alternate numbers of the agent. For example, 9123234000.	String
data[i].time_group.id	The unique ID of the time group assigned. For example, 12345.	integer
data[i].time_group.name	Name of the time group assigned.	String
data[i].failover_destination.id	ID of the failover destination where the call will land in case the agent doesn't pick up the call.	String
data[i].failover_destination.name	Name of the failover destination	String
data[i].failover_destination.type	Type of the failover destination module. For example: agent, department, etc.	String
data[i].users_for_cdr.type	Type of users selected for cdr view. For example: all, none, user	String
data[i].users_for_cdr.value	Value of users selected for cdr view.	String
data[i].is_web_login_block	Whether web login is blocked on the user or not. For example: true or false.	Boolean
data[i].is_login_based_calling	Whether login-based calling is enabled on the user or not. For example: true or false.	Boolean
data[i].is_international_outbound_enabled	Whether internation outbound is enabled on the user or not. For example: true or false.	Boolean