Contact lookup API

Find an Aloware contact by phone number from your own app or system. Send a GET request with your API token and the number, and you get the contact back if one exists.

• Where to find it: Integrations menu > Contact Lookup API in Aloware
• Method: GET
• Auth: your API token, in the query string as api_token
• Lookup key: phone_number
• Format: JSON out

Endpoint

GET /api/v1/webhook/contact/phone-number

Fields

The first two are required; load_info is optional:

Request example

Add both parameters to the URL:

GET https://app.aloware.io/api/v1/webhook/contact/phone-number?api_token=[API_TOKEN]&phone_number=8181234567

Responses

200: contact found

A contact matches the number, and its details come back in the response.

400: bad request

A parameter was missing or invalid. The body tells you what went wrong:

{
"error": "Phone number is empty or invalid."
}

404: no match

No contact has that phone number. The body says so:

{
"error": "Contact not found."
}

cURL example

The same lookup from the command line:

curl --location --request GET 'https://app.aloware.io/api/v1/webhook/contact/phone-number?api_token=[API_TOKEN]&phone_number=8181234567'

Need another endpoint?

For other API functions or any question about this one, email support@aloware.com with what you're trying to do.