Skip to content
WaalaxyWaalaxy AI API

List leads

POST
/v1/leads/list
curl --request POST \
  --url https://developers.waalaxy.ai/v1/leads/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "agentIds": [ "example" ], "linkedinAccountIds": [ "example" ], "searchFilterId": "example", "flowId": "example", "currentStepId": "example", "q": "example", "assigned": "assigned", "relationshipStatus": "ACTIVE_ASSIGNMENT", "handlingFilters": [ "automationActive" ], "outreachStatuses": [ "sourced" ], "blacklisted": true, "page": 1, "limit": 1, "sortBy": "createdAt", "sortDirection": "asc" }'

Search, filter, sort and paginate the leads (read-only, POST for the filter body)

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

POST /v1/leads/list Request body

Media typeapplication/json
object
agentIds
Array<string>
linkedinAccountIds
Array<string>
searchFilterId
string
>= 1 characters
flowId
string
>= 1 characters
currentStepId
string
>= 1 characters
q
string
assigned
string
Allowed values: assigned unassigned any
relationshipStatus
string
Allowed values: ACTIVE_ASSIGNMENT PAST_ASSIGNMENT ACCOUNT_STATE_ONLY UNASSIGNED
handlingFilters
Array<string>
Allowed values: automationActive automationEnded
outreachStatuses
Array<string>
Allowed values: sourced inviteSent inviteAccepted messaged neverReplied hasReplied interested notInterested
blacklisted
boolean
page
integer
> 0 <= 9007199254740991
limit
integer
> 0 <= 200
sortBy
string
Allowed values: createdAt updatedAt name company
sortDirection
string
Allowed values: asc desc

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
status
required
string
Allowed value: success
data
required
object
leads
required
Array<object>
object
id
required
string
workspaceId
required
string
agentId
required
string | null
agent
required
object
id
required
string
name
required
string
activeAssignment
required
object
id
required
string
agentId
required
string
leadId
required
string
linkedinAccountId
required
string
status
required
string
Allowed values: ACTIVE INACTIVE
source
required
string
Allowed values: SEARCH MANUAL AUTO
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
assignedLinkedinAccount
required
object
id
required
string
userId
required
string
firstName
required
string | null
lastName
required
string | null
email
required
string | null
profilePicture
required
string | null
relationshipStatus
required
string
Allowed values: ACTIVE_ASSIGNMENT PAST_ASSIGNMENT ACCOUNT_STATE_ONLY UNASSIGNED
accountState
required
object
id
required
string
leadId
required
string
linkedinAccountId
required
string
inviteAcceptedAt
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
canMessage
required
boolean | null
conversationId
required
string | null
conversationOpenedAt
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
lastCheckedAt
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
outreachStatus
required
string
Allowed values: sourced inviteSent inviteAccepted messaged neverReplied hasReplied interested notInterested
memberId
required
string | null
publicIdentifier
required
string | null
linkedinId
required
integer | null
>= -9007199254740991 <= 9007199254740991
firstName
required
string
lastName
required
string | null
headline
required
string
profileUrl
required
string
profilePicture
required
string | null
region
required
string | null
companyName
required
string | null
companyLinkedinUrl
required
string | null
companyWebsite
required
string | null
premium
required
boolean
influencer
required
boolean
blacklistedAt
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
exitReason
required
object
category
required
string
Allowed values: competitor wrong_job_title wrong_company other existing_conversation
reason
required
string
>= 1 characters
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
totalCount
required
integer
<= 9007199254740991
page
required
integer
> 0 <= 9007199254740991
limit
required
integer
> 0 <= 9007199254740991
hasNextPage
required
boolean
Example
{
  "status": "success",
  "data": {
    "leads": [
      {
        "activeAssignment": {
          "status": "ACTIVE",
          "source": "SEARCH"
        },
        "relationshipStatus": "ACTIVE_ASSIGNMENT",
        "outreachStatus": "sourced",
        "exitReason": {
          "category": "competitor"
        }
      }
    ]
  }
}

400

Section titled “400”

Error, see Errors and rate limits

Media typeapplication/json
object
status
required
string
Allowed value: error
error
required
object
message
required
string
code
string
requestId
string
Example
{
  "status": "error"
}