Sign in
Audience

Search audience members

Search for members within a specific audience using flexible search parameters. Users can only search members of audiences they created.

Search Types:

  • General Search (query): Searches across all fields in the audience member data
  • Field-Specific Search: Use any field name as a parameter (e.g., firstName=john, phoneNumber=123456, email=test@example.com)

Examples:

  • ?query=john - General search across all fields
  • ?firstName=john - Search specifically in firstName field
  • ?phoneNumber=555-1234 - Search specifically in phoneNumber field
  • ?firstName=john&lastName=doe - Search for members matching both criteria

Note: When using phoneNumber field, do not use quotes around the phone number. You can use either a general search OR field-specific searches, but not both simultaneously.

get/audience/{id}/members/search

Path parameters

idstring required
Example:60d0fe4f5311236168a109ca

The unique identifier of the audience

Query parameters

querystring
Example:john

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

*string
Example:field_value

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.

Response

Search results returned successfully

statusboolean

Example response

{
  "status": true,
  "data": {
    "members": [
      {
        "_id": "60d0fe4f5311236168a109cd",
        "data": {
          "phoneNumber": "+1234567890",
          "name": "John Doe",
          "email": "john@example.com"
        }
      }
    ],
    "searchInfo": {
      "searchType": "multiple",
      "searchTerm": "john",
      "searchFields": [
        "firstName",
        "lastName"
      ],
      "totalResults": 5
    }
  }
}

Changes

Changed in 1 of the 52 revisions of this API.13

  • 2bfbd089ccb313See the full diff
    • ●

      added the new multiple enum value to the data/searchInfo/searchType response property for the response status 200

      response-property-enum-value-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      removed the field enum value from the data/searchInfo/searchType response property for the response status 200

      response-property-enum-value-removed