Sign in

v1

latestOpenAPI 3.1.02026-07-13154170539.0 KB
Assistant Management

List all assistants

Returns a list of all assistants belonging to the authenticated user.

get/v0/assistant

Query parameters

phonestring nullable

Only return assistants whose phone number matches this E.164-style value (leading '+' is URL-encoded).

Only return assistants whose phone number matches this E.164-style value (leading '+' is URL-encoded).

emailstring nullable

Only return assistants whose email address matches this value.

Only return assistants whose email address matches this value.

list_all_orgboolean

If True and using an org API key, list ALL assistants in the organization (not just those created by the current user). Requires assistant:read permission.

If True and using an org API key, list ALL assistants in the organization (not just those created by the current user). Requires assistant:read permission.

demoboolean

If True, include demo assistants in results.

If True, include demo assistants in results.

demo_onlyboolean

If True, only return demo assistants.

If True, only return demo assistants.

Response

List of assistants retrieved successfully

Example response

{
  "info": [
    {
      "first_name": "Ada",
      "surname": "Lovelace",
      "age": 28,
      "weekly_limit": 15.75,
      "max_parallel": 2,
      "nationality": "North America",
      "profile_photo": "https://example.com/photos/ada.jpg",
      "profile_video": "https://example.com/videos/ada.mp4",
      "desktop_mode": "windows",
      "user_desktop_id": 1,
      "about": "Mathematician and writer known for work on Analytical Engine",
      "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
      "voice_provider": "elevenlabs",
      "pre_hire_chat": [
        {
          "role": "assistant",
          "msg": "Hello, how can I help you?"
        }
      ],
      "timezone": "America/New_York",
      "user_desktop_url": "https://abc123.tunnel.unify.ai",
      "user_desktop_mode": "macos",
      "agent_id": "12345",
      "user_id": "123",
      "created_at": "2025-04-25T10:30:00Z",
      "updated_at": "2025-04-26T14:15:00Z",
      "phone": "+15551234567",
      "phone_country": "US",
      "email": "ada.lovelace@unify.ai",
      "user_phone": "+15559876543",
      "user_whatsapp_number": "+15559876543",
      "assistant_whatsapp_number": "+15551234567",
      "api_key": "1234567890",
      "user_first_name": "Ada",
      "user_last_name": "Lovelace",
      "user_email": "ada.lovelace@unify.ai",
      "monthly_spending_cap": 100
    }
  ]
}