Get favourites lists for an account

Request

To retrieve the favourites lists for an account, send a GET request to:

http://<host>:<port>/useractivityvault/v1/clientdata/account/{account}/favouriteslists

Headers

Authorization: Bearer – bearer token
Content-Type: application/json

Mandatory arguments

account – the ID of the account (in path)

Other arguments

pretty – specifies that the output should be pretty-printed (that is, in human-readable format) (query parameter)
fields – specifies which fields to return (query parameter). By default, all fields are returned.
limit – the number of favourites to return (query parameter)
offset – the number of favourites to skip (for pagination) (query parameter)
For example:
- ?limit=10 returns the first 10 favourites.
- ?limit=10&offset=10 returns the second 10 favourites.
filter – specifies the tag to filter by (query parameter). You can only specify one tag here.

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

Example

A successful request returns a payload that looks like this:

CODE

{
  "favouritesLists": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "account": "account1234",
      "name": "favourites",
      "creationDate": "2021-01-25T11:32:22.915Z",
      "modifiedDate": "2021-01-25T11:32:22.915Z",
      "metadata": {},
      "tags": []
    }
  ],
  "totalRecords": 1
}