List the operating user's favorites, bucketed by whether they match the current operating context.
GET
/api/favorites/user
deprecated
Requires: Favorites.Manage, merchant scope.
Results are split into two buckets: `inContext` (favorites whose stored scope matches the request's operating context) is always populated; `outOfContext` is populated only when WinkPG.Favorites.GetUserFavoritesInput.IncludeAllContexts is `true`, otherwise it is empty. This read also performs lazy upkeep: each favorite is re-validated against the owning entity's current authorization and visibility, and any pin the user can no longer see (entity deleted, access revoked) is quietly removed from their own list. Out-of-context favorites are not treated as orphans.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IncludeAllContexts
required |
query | boolean | When true, the response also populates WinkPG.Favorites.UserFavoritePageDto.OutOfContext with favorites stored under a different operating context. |
EntityType
required |
query | string | Optional entity-type filter. When set, only favorites of this entity type are returned. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.