SpecifyDocs

List briefing queues

/v1/briefing-queues/{listenerPrincipalId}/items

Signed-in session or agent keyLaunch key product.briefingsOperation briefing_queue_list

Written and audio briefings from a person's work and memory: schedules, a listening queue, one player that keeps playing across the suite, a private feed and verified email delivery.

Path parameters

listenerPrincipalIdstringRequired

Query parameters

querystring
cursorstring
reasonCode"AI_BALANCE_EXHAUSTED" | "AUDIO_EXPIRED" | "CHECKING_PROVIDER_RESULT" | "CONSENT_REVOKED" | "NEEDS_RENDER_APPROVAL" | "PERMISSION_LOST" | "PLAYBACK_UNAVAILABLE" | "QUEUE_BUDGET_EXCEEDED" | "RENDER_FAILED" | "SCHEDULE_BUDGET_EXCEEDED" | "SOURCE_REVOKED" | "WAITING_FOR_RENDER_SLOT"
limitnumber
terminalState"completed" | "removed" | "skipped" | "withdrawn"
view"active" | "history" | "own_submissions"Required

Returns

errorobject
schemaVersion1
itemsany[] | object[]
orderVersionnumber | any
nextCursornull | null | string
seenSequencenumber
sessionnull | object
activeItemIdstring
unseenCountnumber

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.