Audiences

List audience members

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Get a paginated list of the customer profiles in a given audience.

A maximum of 1000 customer profiles per page is allowed.

get/v1/audiences/{audienceId}/memberships

Request

Path parameters

audienceIdinteger required

The ID of the audience.

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

profileQuerystring

The filter to select a profile.

Response

OK

hasMoreboolean

Example response

{
  "data": [
    {
      "id": 6,
      "created": "2020-02-07T08:15:22Z",
      "integrationId": "URNGV8294NV",
      "attributes": {
        "Language": "english",
        "ShippingCountry": "DE"
      },
      "accountId": 31,
      "closedSessions": 3,
      "totalSales": 299.99,
      "loyaltyMemberships": [
        {
          "joined": "2012-03-20T14:15:22Z",
          "loyaltyProgramId": 323414846
        }
      ],
      "audienceMemberships": [
        {
          "id": 2,
          "name": "Travel audience"
        }
      ],
      "lastActivity": "2020-02-08T14:15:20Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.