Skip to content
WaalaxyWaalaxy AI API

List conversations

GET
/v1/inbox/conversations
curl --request GET \
  --url 'https://developers.waalaxy.ai/v1/inbox/conversations?scope=todo&filter=toValidate&limit=25' \
  --header 'Authorization: Bearer <token>'

List the inbox conversations, with filters and a cursor

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
agentId
string
>= 1 characters

GET /v1/inbox/conversations Parameter

linkedinAccountId
string
>= 1 characters

GET /v1/inbox/conversations Parameter

q
string
>= 1 characters

GET /v1/inbox/conversations Parameter

scope
required
string
Allowed values: todo all

GET /v1/inbox/conversations Parameter

filter
string
Allowed values: toValidate coldSequenceToValidate replyToValidate missingInformation interested notInterested noReply ongoing

GET /v1/inbox/conversations Parameter

cursor
string
>= 1 characters

GET /v1/inbox/conversations Parameter

limit
integer
default: 25 > 0 <= 200

GET /v1/inbox/conversations Parameter

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
status
required
string
Allowed value: success
data
required
object
items
required
Array<object>
object
enrollmentId
required
string
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))$/
status
required
string
Allowed values: ACTIVE WAITING COMPLETED FAILED CANCELLED
tag
required
string
Allowed values: coldSequenceToValidate coldSequenceWaitingForSlot replyToValidate missingInformation interested notInterested noReply ongoing
selectedOutcome
required
string | null
Allowed values: interested notInterested
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))$/
agentNextAction
required
One of: discriminator: kind
object
kind
required
string
Allowed value: preparingReply
pendingHandoff
required
object
id
required
string
note
required
string
category
required
string
""
pendingValidation
required
object
id
required
string
kind
required
string
Allowed values: message coldSequence
preview
required
string
generating
required
boolean
regenerating
required
boolean
coldOpenerPreview
required
string | null
lastMessagePreview
required
string | null
lead
required
object
id
required
string
firstName
required
string
lastName
required
string | null
headline
required
string
companyName
required
string | null
profilePicture
required
string | null
agent
required
object
id
required
string
name
required
string
linkedinAccount
required
object
id
required
string
userId
required
string
firstName
required
string | null
lastName
required
string | null
email
required
string | null
profilePicture
required
string | null
memberId
required
string | null
nextCursor
required
string | null
Example
{
  "status": "success",
  "data": {
    "items": [
      {
        "status": "ACTIVE",
        "tag": "coldSequenceToValidate",
        "selectedOutcome": "interested",
        "agentNextAction": {
          "kind": "preparingReply"
        },
        "pendingHandoff": {
          "category": ""
        },
        "pendingValidation": {
          "kind": "message",
          "generating": false,
          "regenerating": false
        }
      }
    ]
  }
}

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"
}