Create a query for privileged memberships

post/query/privilegedMemberships

Enables a client to define a query to determine which values in a set are key values of a list. IDs must be unique within a set of query objects.

The query returns a set of values or members that exist for the list. The feature also enables a client to send multiple queries in a single request.

Request Samples

Response Samples


1{
2  "version": 1,
3  "correlationId": "correlationID",
4  "includeDeveloping": false,
5  "includeExpired": false,
6  "results": [
7    {
8      "id": "Cards for first list ID",
9      "listId": "8e1cc4db-9b35-4097-b389-8746f72dbcfd",
10      "listName": "cc_list_2026",
11      "listLabel": "List label for first list ID",
12      "members": [
13        "347766454953686",
14        "5717705214312255",
15        "6011661176836511"
16      ]
17    },
18    {
19      "id": "Cards for second list ID",
20      "listId": "9b5f06ba-9a38-4755-8659-f2cd7429e112",
21      "listName": "cc_list_2027",
22      "listLabel": "List label for second list ID",
23      "members": []
24    }
25  ]
26}

Request Body

This schema defines the membership queries from a client.

Name	Type	Required	Description
correlationId	string	false	An optional ID that is provided by the client to associate a request to its response.
includeDeveloping	boolean	false	An indicator for whether to include records that are in the developing state in the membership query results. Records in the deployed state are always included, regardless of this flag's value. The default value is 'false'.
includeExpired	boolean	false	An indicator for whether to include records that have expired in the membership query results. The default value is 'false'.
queries	array [object]	false	A collection of query objects, where each query object corresponds to a specific list.

Responses

Status	Meaning	Description
201	Created	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
403	Forbidden	The user did not have the necessary permissions.		Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.		Schema