Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
funnels
/
{id}
/
cards
List pipeline cards
curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/cards \
  --header 'api_access_token: <api-key>'
[
  {
    "id": 55,
    "funnel_id": 3,
    "funnel_stage_id": 7,
    "lead": {
      "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"
    },
    "position": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

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.

​
id
integer
required

The ID of the pipeline.

Query Parameters

​
lead_status
enum<string>

Filter cards by the associated lead status.

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

Filter cards by stage.

Response

List of cards.

​
id
integer
Example:

55

​
funnel_id
integer
Example:

3

​
funnel_stage_id
integer
Example:

7

​
lead
object
​
position
integer
Example:

1

​
created_at
string<date-time>
​
updated_at
string<date-time>