Skip to main content
GET
List leads

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