Skip to main content
GET
/
api
/
contact
/
list-generator
Get contacts for list generator
curl --request GET \
  --url https://your-instance.example.com/api/contact/list-generator \
  --header 'Authorization: Bearer <token>'
{
  "contacts": [
    {
      "id": "<string>",
      "name": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "status": "<string>",
      "pipelineStage": "<string>",
      "lastMessageDate": "2023-11-07T05:31:56Z",
      "messageCount": 123
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "totalPages": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

stages
string

JSON array

timeRange
string

JSON object

dateRange
string

JSON object

page
integer
default:1
Required range: x >= 1
limit
integer
default:10
Required range: x >= 1
searchValue
string
messageStatus
enum<string>
Available options:
all,
answered,
unanswered
messageCountValue
integer

Response

Contacts returned

contacts
object[]
total
integer
page
integer
limit
integer
totalPages
integer