Skip to main content
GET
/
api
/
v1
/
get-contact
/
{phone_number}
Get contact by phone number
curl --request GET \
  --url https://api.voxworks.ai/api/v1/get-contact/{phone_number} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "contact": {
    "id": "<string>",
    "team_id": "<string>",
    "phone_number": "+61429069971",
    "first_name": "<string>",
    "last_name": "<string>",
    "full_name": "<string>",
    "email": "<string>",
    "object_data": {}
  }
}

Authorizations

​
Authorization
string
header
required

API key from Voxworks, sent as Authorization: Bearer YOUR_API_KEY.

Path Parameters

​
phone_number
string
required

Contact phone number. URL-encode a leading + as %2B.

Response

Contact found.

​
success
boolean
required
Example:

true

​
contact
object
required