Search a contact using Number

GET

/contacts/search

Description :

Contacts represent the data stored for the contacts that are available within your Phone.com account. This API helps search contacts using search criteria. Search criteria in the format: 'property(:|<|>)value'. Multiple search criterias are supported.

URL :

https://connect.beetexting.com/pdc-prod/contacts/search?q=13462958864&page=0&size=5
(While sending the request please make sure to append https://connect.beetexting.com/pdc-prod if the url in the cUrl command starts with /message ...)

**Note : To add the OAuth2.0 Auth Token please see the section 'OAuth2.0 For Phone.com' and 'Postman How-to for Phone.com section'

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/contacts/search?q=13462958864&page=0&size=5&sort' \
--header 'x-api-key: HvG7OZaxgz3raDMzX9CYp9105hV9VwDa6zrCS234' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "totalPages": 0,
    "totalElements": 0,
    "numberOfElements": 0,
    "pageable": {
        "pageNumber": 0,
        "pageSize": 0,
        "paged": true,
        "unpaged": true,
        "offset": 0,
        "sort": {
            "sorted": true,
            "unsorted": true,
            "empty": true
        }
    },
    "number": 0,
    "first": true,
    "last": true,
    "size": 0,
    "content": [
        {
            "id": "string",
            "firstName": "string",
            "lastName": "string",
            "name": "string",
            "mobileNumber": "981712129981",
            "notes": [
                {
                    "id": "string",
                    "createdAgentName": "string",
                    "message": "string",
                    "creationDate": 0,
                    "lastUpdatedDate": 0,
                    "noteAssociatedType": "CONTACT",
                    "contactId": "string",
                    "agentId": "string"
                }
            ],
            "tags": "[tag1, tag2, tag3..]",
            "email": "string",
            "blocked": false,
            "optOutStatus": false,
            "donotDisturb": false
        }
    ],
    "sort": {
        "sorted": true,
        "unsorted": true,
        "empty": true
    },
    "empty": true
}

Modified at 2025-10-27 17:56:16

Find contact using Mobile number

Create or Update Contact