Subscriber Lists

List subscribers on a list, with their contact data

Project-scoped equivalent of GET /v1/subscriber-lists/{id} (which is a legacy flat URL shape kept for hosted signup forms and one-click-unsubscribe links). Each item merges the subscriber's per-list status with their contact data - custom field values come back nested under a "customFields" object here, not flattened onto top-level keys like GET /v1/projectId/{projectId}/contacts.

get/v1/projectId/{projectId}/subscriber-lists/{id}/subscribers

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/subscriber-lists/{id}/subscribers
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

idstring required

The subscriber list _id.

Query parameters

limitinteger

Max items per page. Capped at 30.

skipinteger

Number of items to skip, for pagination.

sort'updatedAt' | 'createdAt'

Field to sort by.

order'asc' | 'desc'
filter[<field>]string

Exact-match filter on a top-level field, e.g. filter[name]=Welcome. Repeatable for multiple fields.

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.