Skip to main content
GET
/
org
/
{org_id}
/
prospects
List prospects
curl --request GET \
  --url https://v2-nova-api.prod.czmx.in/org/{org_id}/prospects
{
  "data": [
    {
      "country": "<string>",
      "created_at": "<string>",
      "email": "<string>",
      "external_id": "<string>",
      "first_name": "<string>",
      "id": "<string>",
      "last_name": "<string>",
      "list_id": "<string>",
      "phone": "<string>",
      "status": "<string>",
      "tags": [
        {
          "color": "<string>",
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "timezone": "<string>"
    }
  ],
  "meta": {
    "page": 123,
    "size": 123,
    "total": 123,
    "total_pages": 123
  }
}

Path Parameters

org_id
string
required

Organization ID

Query Parameters

page
integer
default:1

Page number

size
integer
default:20

Page size

list_id
string

Filter by prospect list ID

no_list
boolean

Filter prospects without a list

status
string

Filter by status

country
string

Filter by country code

tag_id
string

Filter by tag ID

Search in name, phone, email

Response

OK

data
object[]
meta
object