Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
leads
List leads
curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/leads \
  --header 'api_access_token: <api-key>'
{
  "data": [
    {
      "id": 42,
      "custom_name": "Enterprise Deal - Q3",
      "status": "open",
      "lead_value": 15000,
      "lead_currency": "USD",
      "position": 1,
      "notes": "Prospect from trade show",
      "assigned_agent": {
        "id": 1,
        "name": "Jane Smith",
        "email": "jane@example.com",
        "avatar_url": "<string>"
      },
      "company": {
        "id": 10,
        "name": "Acme Corp",
        "domain": "acme.com"
      },
      "conversation_id": 100,
      "custom_attributes": {
        "industry": "Technology",
        "annual_revenue": 500000
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_access_token
string
header
required

API access token for authentication. Obtain from your Voxys Connect profile settings.

Path Parameters

​
account_id
integer
required

The numeric ID of the account.

Query Parameters

​
status
enum<string>

Filter leads by status.

Available options:
open,
won,
lost,
snoozed
​
assigned_agent_id
integer

Filter leads assigned to a specific agent.

​
source_inbox_id
integer

Filter leads originating from a specific inbox.

​
sort_by
enum<string>
default:created_at

Field to sort results by.

Available options:
created_at,
updated_at,
lead_value,
position,
custom_name
​
sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
page
integer
default:1

Page number for pagination.

​
per_page
integer
default:25

Number of records per page.

Required range: x <= 100

Response

Paginated list of leads.

​
data
object[]
​
meta
object