identity
GET /v1/me/overview-shortcuts
Get this person's Overview shortcut cards.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/me/overview-shortcuts \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The shortcut cards this person pinned to their dashboard Overview, in the order they appear. ⚖️ Owner, 2026-09-11: "on the overview screen we should have shortcuts to most-used sections, and the user should be able to select from all the sections and menu items to add their own shortcuts". ⛔ The ids are the dashboard's own navigation ids and are stored OPAQUELY. The section list is built per render from the caller's entitlements, permissions, brand and product lines — roughly 200 entries — so an allow-list in the engine would be correct on the day it was typed and would then start refusing nav entries shipped after it. The client resolves each id against the live tree it is already holding and drops what no longer exists. ⛔ Read chosen before rendering. An empty list with chosen: false means nobody has ever chosen and the client shows its presets; the identical list with chosen: true means this person deliberately removed every card, and the presets must NOT grow back.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
shortcuts | OverviewShortcutIds | Yes | Dashboard navigation ids, in the order the cards appear. Opaque to the engine: it bounds the count, the length and the charset and stores the rest verbatim, because the section… |
chosen | boolean | Yes | Whether this person has ever chosen. ⛔ Not inferable from an empty list, which is why it is on the wire: false with an empty list means nobody has chosen and the client shows… |
Errors this endpoint can return
401 · 403 · 429