Skip to main content
GET
/
audience
/
{id}
/
members
/
search
Search audience members
curl --request GET \
  --url https://atoms-api.smallest.ai/api/v1/audience/{id}/members/search \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "data": {
    "members": [
      {
        "_id": "60d0fe4f5311236168a109cd",
        "data": {
          "phoneNumber": "+1234567890",
          "name": "John Doe",
          "email": "john@example.com"
        }
      }
    ],
    "searchInfo": {
      "searchType": "field",
      "searchTerm": "john",
      "searchFields": [
        "firstName",
        "lastName"
      ],
      "totalResults": 5
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The unique identifier of the audience

Example:

"60d0fe4f5311236168a109ca"

Query Parameters

​
query
string

General search term that searches across all fields in audience member data

Example:

"john"

​
*
string

Any field name can be used as a query parameter for field-specific searches. Examples: firstName, lastName, phoneNumber, email, etc. The parameter name becomes the field to search in, and the value is the search term. When using phoneNumber field, do not use quotes around the phone number.

Example:

"field_value"

Response

Search results returned successfully

​
status
boolean
Example:

true

​
data
object
⌘I