Contacts

List contacts (legacy flat URL shape)

Legacy flat URL shape, kept for backward compatibility - identical behavior to GET /v1/projectId/{projectId}/contacts above.

get/v1/contacts/{projectId}

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/contacts/{projectId}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

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

Query parameters

filterobject

mongoose-crudl style filter object. Two special keys narrow by segment conditions (AND-ed with each other and the rest of the filter): filter[segmentId]=<saved segment id>, and filter[segment]=<JSON {"groups": [...]}> with the same groups/conditions shape as a segment (e.g. has-tag, equals on a custom field, engagement). filter[subscriberListId]=<id> keeps only contacts on that subscriber list, optionally with filter[subscriberStatus]=active|unsubscribed|paused|unverified.

limitinteger
skipinteger

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

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