Skip to main content
GET
/
v1
/
links
List Links
curl --request GET \
  --url https://api.agenthuman.com/v1/links \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "links": [
    {
      "link_id": "lnk_01J8ZK4R2N5M6P7Q8W4T",
      "name": "Product Demo",
      "url": "https://app.agenthuman.com/s/lnk_01J8ZK4R2N5M6P7Q8W4T",
      "agent": {
        "agent_id": "agnt_01J8ZK4R2N5M6P7Q8W4T",
        "name": "Support Agent",
        "avatar_image_url": "https://cdn.example.com/avatars/support.jpg",
        "created_at": "2024-01-15T10:00:00Z",
        "voice_agent": {
          "provider": "ElevenLabs",
          "agent_id": "el_agent_xxxxxxxxxxxxxxxx",
          "auth_method": "public"
        }
      },
      "status": "active",
      "uses": 12,
      "use_limit": 100,
      "created_at": "2024-01-15T10:30:00Z",
      "expires_at": "2024-02-15T10:30:00Z"
    }
  ]
}

​
Query Parameters

​
status
string
default:"all"
Filter links by status. Must be one of: active, paused, expired. Omit or pass all to return all links.

​
Response

​
success
boolean
Whether the request was successful.
​
links
array
Array of Link objects, ordered by created_at descending. Each link includes the full nested Agent object.
{
  "success": true,
  "links": [
    {
      "link_id": "lnk_01J8ZK4R2N5M6P7Q8W4T",
      "name": "Product Demo",
      "url": "https://app.agenthuman.com/s/lnk_01J8ZK4R2N5M6P7Q8W4T",
      "agent": {
        "agent_id": "agnt_01J8ZK4R2N5M6P7Q8W4T",
        "name": "Support Agent",
        "avatar_image_url": "https://cdn.example.com/avatars/support.jpg",
        "created_at": "2024-01-15T10:00:00Z",
        "voice_agent": {
          "provider": "ElevenLabs",
          "agent_id": "el_agent_xxxxxxxxxxxxxxxx",
          "auth_method": "public"
        }
      },
      "status": "active",
      "uses": 12,
      "use_limit": 100,
      "created_at": "2024-01-15T10:30:00Z",
      "expires_at": "2024-02-15T10:30:00Z"
    }
  ]
}