Get an Agent Details

Use this endpoint to fetch details for a specific agent by providing the agent’s {id} in the path.
It returns the full agent object, including key metadata such as ID, name, role, status etc..

This endpoint is typically used to:

View a single agent’s full profile in your dashboard.

Validate an agent_id before using it in routing, assignment, or automation flows.

Retrieve the latest agent details after updates (e.g., role or status changes).

💡

If you don’t have the agent {id}, call List All Agents API first to get the available agent IDs and basic details.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200ContactDetails

application/json

Body

Example

{
    "id": 1,
    "platform_id": "1234567890",
    "platform": "WhatsApp",
    "is_agent": true,
    "business_id": "550e8400-e29b-41d4-a716-446655440000",
    "chat_status": "online",
    "created_at": "2024-11-24T10:00:00Z",
    "updated_at": "2024-11-24T11:00:00Z",
    "contact_meta": {
        "last_message_at": "2024-11-23T15:30:00Z",
        "status": "active"
    },
    "contact_profile": {
        "name": "John Doe",
        "display_name": "John",
        "address": "123 Main St, Springfield",
        "email": "johndoe@example.com",
        "country": "US",
        "image": "https://example.com/profile.jpg",
        "language": "en",
        "role": "customer"
    },
    "tags": [
        {
            "id": 101,
            "name": "VIP",
            "color": "#FFD700"
        },
        {
            "id": 102,
            "name": "Support",
            "color": "#00FF00"
        }
    ]
}

🔴500InternelError

🟠400BadRequest

🟢200OK

Request

Request Code Samples

Responses