Documentation | Audiences › List Members

API Reference

Bulk Operations

Audiences

audiences

Methods

Add Members -> string

post/v1/audiences/{key}/members

Add members

List Members -> { entries, page_info }

get/v1/audiences/{key}/members

List members

Parameters

key: string

Response fields

entries: Array<

>

page_info: { __typename, page_size, after, 1 more... }

The information about a paginated result

Request example

curl https://api.knock.app/v1/audiences/$KEY/members \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "entries": [
    {
      "__typename": "AudienceMember",
      "added_at": "2021-01-01T00:00:00Z",
      "user": {
        "id": "jane",
        "__typename": "User",
        "updated_at": "2024-05-22T12:00:00Z",
        "avatar": "avatar",
        "created_at": null,
        "email": "[email protected]",
        "name": "Jane Doe",
        "phone_number": "phone_number",
        "timezone": "timezone"
      },
      "user_id": "user_123",
      "tenant": "acme_corp"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "page_size": 25,
    "after": null,
    "before": null
  }
}

Remove Members -> string

delete/v1/audiences/{key}/members

Remove members

Domain types

AudienceMember = { __typename, added_at, user, 2 more... }

A user belonging to an audience