Skip to main content
GET
/
audience
/
{id}
/
members
Get audience members
curl --request GET \
  --url https://atoms-api.smallest.ai/api/v1/audience/{id}/members \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "data": {
    "members": [
      {
        "_id": "60d0fe4f5311236168a109cd",
        "data": {
          "phoneNumber": "+1234567890",
          "name": "John Doe",
          "email": "[email protected]"
        }
      }
    ],
    "totalCount": 150,
    "totalPages": 15,
    "hasMore": true
  }
}

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

​
page
integer
default:1

Page number for pagination (default is 1)

Required range: x >= 1
Example:

1

​
offset
integer
default:5

Number of items per page (default is 5)

Required range: x >= 1
Example:

10

Response

Successfully retrieved audience members

​
status
boolean
Example:

true

​
data
object