List leads

GET

/api/v1/leads

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/leads?page=1&limit=25&is_client=true&engagement_tier=cold&do_not_contact=true' \
  --header 'Authorization: Bearer <token>'

Paginated. Results are limited to the leads the caller may view (own, team or all, by role); restricted custom fields are masked.

Authorizations

• bearerJwt
• personalAccessToken
  read:leads
• oauthAccessToken

Parameters

Query Parameters

page

number

default: 1 >= 1

limit

number

default: 25 >= 1 <= 100

sort

string

search

string

<= 200 characters

status_id

string

owner_id

string

is_client

string

Allowed values: true false

engagement_tier

string

Allowed values: cold warm hot

ai_score_min

number

<= 100

ai_score_max

number

<= 100

recording_transcript_contains

string

>= 2 characters <= 200 characters

smart_view_id

string

/^[0-9a-fA-F]{24}$/

qualified_state

string

<= 200 characters

do_not_contact

string

Allowed values: true false

Responses

200

A page of leads

Media typeapplication/json

object

leads

required

Array<object>

object

_id

required

string

name

required

string

key

additional properties

any

total

required

number

page

required

number

limit

required

number

totalPages

required

number

Example^generated

{
  "leads": [
    {
      "_id": "example",
      "name": "example"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1,
  "totalPages": 1
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}