Skip to main content
POST
/
api
/
contacts
/
phoneNumber
Get contact by phone number
curl --request POST \
  --url https://your-instance.example.com/api/contacts/phoneNumber \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "+14165550100"
}
'
{
  "data": {
    "_id": "64f0a1b2c3d4e5f6a7b8c9d0",
    "firstName": "Jane",
    "lastName": "Doe",
    "phoneNumber": [
      {
        "value": "+14165550100",
        "isPrimary": true
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
phoneNumber
string
required

Phone number to look up; normalized to E.164 before querying.

​
targetUserId
string

Optional user id to scope the lookup to a specific rep when the caller has cross-user access.

Response

Contact returned

​
data
object
Example:
{
  "_id": "64f0a1b2c3d4e5f6a7b8c9d0",
  "firstName": "Jane",
  "lastName": "Doe",
  "phoneNumber": [
    {
      "value": "+14165550100",
      "isPrimary": true
    }
  ],
  "secondaryPhoneNumber": [],
  "email": "jane.doe@example.com",
  "status": "New Lead",
  "pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1",
  "pipelineStage": "64f0a1b2c3d4e5f6a7b8c9d2",
  "organizationId": "64f0a1b2c3d4e5f6a7b8c9d3",
  "userId": "64f0a1b2c3d4e5f6a7b8c9d4",
  "createdBy": "64f0a1b2c3d4e5f6a7b8c9d4",
  "assignees": ["64f0a1b2c3d4e5f6a7b8c9d4"],
  "createdAt": "2026-05-01T14:30:00.000Z",
  "updatedAt": "2026-05-15T09:12:00.000Z"
}
​
message
string
​
error
string