Direct messages, notifications and live events
List nudges
Lists the nudges sent to the caller: short prompts from a supervisor, each showing who sent it and whether it has been seen. Set scope to all to list every nudge in the workspace.
Requires: desk.read scope.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Query Parameters
scope?string
received (the default): nudges sent to you that you have not seen. sent: the nudges you sent (supervisors, owners and admins). all: every nudge in the workspace (owners and admins only).
cursor?string
next_cursor from the previous page. Leave it out for the first page.
limit?integer
Page size: 100 by default, 100 at most.
Response
OK
Example
{ "data": [ { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "to_user_id": "e8b0e73c-b2e7-4411-9b1c-a87c71fe74c6", "to_name": "Brian Otieno", "from_user_id": "20ca6d33-8b9a-4b10-9115-814d810ca66f", "from_name": "Example Support", "preset": "call-back", "text": "Hi Amina, your order has shipped.", "ticket_id": "b1e8bf6f-7f06-4c91-96dd-a1eb7abe504b", "ticket_ref": "TCK-4471", "call_id": "5f8fdfd7-274f-478d-9141-184cd8996e3f", "sent_at": "2026-10-14T08:30:00Z", "seen_at": "2026-10-14T08:30:00Z" } ], "next_cursor": "eyJvIjoyNX0", "has_more": false}FieldTypeDescription
datarequiredobject[]idrequiredstring (uuid)to_user_idrequiredstring (uuid)The id of the person to transfer the call to.to_namerequiredstringThe name of the person receiving it.from_user_idrequiredstring (uuid)from_namerequiredstringThe name customers see on your emails.presetrequiredstring | nullA ready-made nudge to send, in place of your own words.textrequiredstringYour own words for the nudge.ticket_idrequiredstring (uuid) | nullThe id of the ticket this is about.ticket_refrequiredstring | nullcall_idrequiredstring (uuid) | nullThe id of the call this nudge is about, if any.sent_atrequiredstring (date-time)seen_atrequiredstring (date-time) | nullnext_cursorrequiredstring | nullhas_morerequiredbooleancurl -X GET "https://api.sautidesk.com/v1/desk/nudges"