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": "<string>",
  "targetUserId": "<string>"
}
'
{
  "data": {
    "_id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "status": "<string>",
    "pipelineId": "<string>",
    "pipelineStage": "<string>",
    "organizationId": "<string>",
    "userId": "<string>",
    "createdBy": "<string>",
    "assignees": [
      "<unknown>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "error": "<string>"
}

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
targetUserId
string

Response

Contact returned

data
object
message
string
error
string