List newsletter subscriptions

List newsletter subscribers for a location.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

newsletter:subscriptions:read

Query Parameters

Name	Type	Required	Description
`locationId`	string	Required	Location to query.
`limit`	number	Optional	Maximum number of items to return (1-100).Default: `20`
`offset`	number	Optional	Number of items to skip before starting to collect the result set.Default: `0`
`sortBy`	string	Optional	Field to sort by. Allowed values vary by endpoint.Default: `createdAt`
`sortOrder`	string asc desc	Optional	Sort direction.Default: `desc`
`search`	string	Optional	Free-text search across the resource’s primary fields.
`createdAfter`	string	Optional	ISO 8601 timestamp — only return items created after this time.
`createdBefore`	string	Optional	ISO 8601 timestamp — only return items created before this time.
`updatedAfter`	string	Optional	ISO 8601 timestamp — only return items updated after this time.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/newsletter-subscriptions" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Newsletter subscriptions retrieved successfully!",
  "content": {
    "subscriptions": [
      {
        "id": "sub_1",
        "email": "subscriber@example.com"
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

No console screen

Subscribers sign up on the location's public website, not in the console. This endpoint is the only way to read the list.