Audience

Get audience members

Changed on

Retrieve members of a specific audience with pagination support. Users can only access members of audiences they created.

get/audience/{id}/members

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/audience/{id}/members
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:60d0fe4f5311236168a109ca

The unique identifier of the audience

Query parameters

pageinteger
Example:1

Page number for pagination (default is 1)

offsetinteger
Example:10

Number of items per page (default is 5). Note: this parameter is named "offset", not "limit" — sending ?limit=N is silently ignored.

Response

Successfully retrieved audience members

statusboolean

Example response

{
  "status": true,
  "data": {
    "members": [
      {
        "_id": "60d0fe4f5311236168a109cd",
        "data": {
          "phoneNumber": "+1234567890",
          "name": "John Doe",
          "email": "john@example.com"
        }
      }
    ],
    "totalCount": 150,
    "totalPages": 15,
    "hasMore": true
  }
}

Changes

  • 2bfbd089ccb3Revision changes
    • warning

      deleted the query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 8e52b2362d0aRevision changes
    • warning

      deleted the query request parameter offset

    • info

      added the new optional query request parameter limit