On this page
myBookmarks
query · in the family Your own session
What it does
Your own bookmark list — the records you (and your teams) subscribed to.
The calling principal's raw bookmark rows. scope defaults ALL. Bounded by the per-subject cap. Requires authentication.
Who may call it
Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:myBookmarks
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
scope | FeedScope | no | No further notes. |
Returns
BookmarkRef [BookmarkRef!]! — One raw bookmark row.
Example request
query ExampleMyBookmarks($scope: FeedScope) {
myBookmarks(scope: $scope) {
subjectKind
ownerId
targetType
targetId
createdAt
createdBy
boostedAt
popAt
highlightedAt
}
}
Variables:
{
"scope": "ALL"
}
Example response
{
"data": {
"myBookmarks": [
{
"subjectKind": "USER",
"ownerId": "01900000-0000-7000-8000-e51b6a790000",
"targetType": "<target type>",
"targetId": "01900000-0000-7000-8000-446adfd50000",
"createdAt": "2027-01-31T00:00:00.000Z",
"createdBy": "01900000-0000-7000-8000-0b14e5a60000",
"boostedAt": "2027-01-31T00:00:00.000Z",
"popAt": "2027-01-31T00:00:00.000Z",
"highlightedAt": "2027-01-31T00:00:00.000Z"
}
]
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)