Search contacts by name, email or phone

GET

/api/v1/contacts/search

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/contacts/search?q=example' \
  --header 'Authorization: Bearer <token>'

Results are limited to contacts of leads the caller may view.

Authorizations

• bearerJwt
• personalAccessToken
  read:contacts
• oauthAccessToken

Parameters

Query Parameters

q

required

string

>= 1 characters <= 100 characters

has_phone

string

limit

string

Responses

200

Matching contacts

Media typeapplication/json

object

contacts

required

Array<object>

object

_id

required

string

lead_id

required

string

first_name

required

string

last_name

required

string

email

required

string | null

phone

required

string | null

key

additional properties

any

Example^generated

{
  "contacts": [
    {
      "_id": "example",
      "lead_id": "example",
      "first_name": "example",
      "last_name": "example",
      "email": "example",
      "phone": "example"
    }
  ]
}

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