Get User Role By Team

GET

/v2/api/team/agents/{agent_id}

This endpoint allows you to retrieve the role of a specific user (agent) within a team by providing the agent's unique identifier. If the user has a role assigned within the team, the role will be returned in the response. If no role is found for the agent in the specified team, an error message will be provided to indicate that no role has been assigned.

Key Features:

Retrieve the user's role in a specific team based on their agent ID.

Provides a successful response when a role is found, including the user's specific role in the team (e.g., Admin, Viewer, Owner).

Request Parameters:

agent_id: The unique identifier of the agent whose role you wish to retrieve.

How to Find Your Agent ID

If you're unsure about the agent_id, follow this guide:
How to View Agent ID

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/team/agents/0' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "User role retrieved successfully",
    "data": {
        "role": "Owner"
    }
}

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Successfully retrieved user role for the specified team.

Body

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Get Teams Of User

Get Agents Of User Team

Get User Role By Team

How to Find Your Agent ID#

Request

Responses

How to Find Your Agent ID