# UserFavoritePageDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

## Fields
- `inContext` (array<[UserFavoriteDto](https://devportal.demo.winkpg.io/docs/api/models/UserFavoriteDto.md)>): Favorites whose stored context matches the request's operating context. (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `creationTime` (string(date-time)): The date and time when this entity was created.
  - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
  - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
  - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
  - `isDeleted` (boolean): Indicates whether this entity has been deleted.
  - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
  - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
  - `userId` (string(uuid))
  - `tenantId` (string(uuid)): (nullable)
  - `resellerId` (string(uuid)): (nullable)
  - `merchantId` (string(uuid)): (nullable)
  - `entityType` (string): (nullable)
  - `entityId` (string(uuid))
  - `scope` ([FavoriteScope](https://devportal.demo.winkpg.io/docs/api/models/FavoriteScope.md)): Organizational scope for a pinned favorite.  Determines which operating-context fields the favorite is bound to.
    Values:
    - `Tenant`
    - `Reseller`
    - `Merchant`
  - `label` (string): (nullable)
  - `subtitle` (string): (nullable)
  - `route` (string): (nullable)
  - `pinnedAtUtc` (string(date-time))
  - `inContext` (boolean): True if this favorite's stored context matches the request's operating context.  Computed server-side after lazy validation.
- `outOfContext` (array<[UserFavoriteDto](https://devportal.demo.winkpg.io/docs/api/models/UserFavoriteDto.md)>): Favorites stored under a different operating context. Empty unless  `includeAllContexts` is true. (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `creationTime` (string(date-time)): The date and time when this entity was created.
  - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
  - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
  - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
  - `isDeleted` (boolean): Indicates whether this entity has been deleted.
  - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
  - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
  - `userId` (string(uuid))
  - `tenantId` (string(uuid)): (nullable)
  - `resellerId` (string(uuid)): (nullable)
  - `merchantId` (string(uuid)): (nullable)
  - `entityType` (string): (nullable)
  - `entityId` (string(uuid))
  - `scope` ([FavoriteScope](https://devportal.demo.winkpg.io/docs/api/models/FavoriteScope.md)): Organizational scope for a pinned favorite.  Determines which operating-context fields the favorite is bound to.
    Values:
    - `Tenant`
    - `Reseller`
    - `Merchant`
  - `label` (string): (nullable)
  - `subtitle` (string): (nullable)
  - `route` (string): (nullable)
  - `pinnedAtUtc` (string(date-time))
  - `inContext` (boolean): True if this favorite's stored context matches the request's operating context.  Computed server-side after lazy validation.
- `totalCount` (integer(int32)): Total favorites across both buckets.

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.