List suggestions
/suggestionsAuthorization
bearerAuth Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.
In: header
Query Parameters
uuid1 <= value <= 10025length <= 8192"active"Value in
- "active"
- "history"
Value in
- "suggested"
- "accepted"
- "completed"
- "dismissed"
- "withdrawn"
uuidValue in
- "speaker"
- "mention"
- "actor"
- "recipient"
date-timedate-time"false"Value in
- "true"
- "false"
Header Parameters
Send 1 to pin the documented API contract. If omitted, the latest version is selected.
"1"Value in
- "1"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/suggestions" \ -H "X-API-Version: 1"{ "success": true, "data": { "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0", "items": [ { "action": "string", "why_now": "string", "basis": "stated_intent", "roles": [], "due": { "wording": "string", "at": "2019-08-24T14:15:22Z", "timezone": "string", "uncertain": true }, "not_before": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "expiry_explanation": "string", "presentation": null, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0", "revision": 1, "state": "suggested", "state_version": 1, "protected_fields": [ "/action" ], "grouping": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "version": 1, "label": "string", "member_ids": [ "6059d331-91d8-43de-a6af-f1a743933a5b", "6059d331-91d8-43de-a6af-f1a743933a5b" ] }, "canonical_id": "427e30c8-bfd7-48b3-b48e-acffdd2452c2", "needs_review": true, "review_reason": "string", "snoozed_until": "2019-08-24T14:15:22Z", "first_surfaced_at": "2019-08-24T14:15:22Z", "last_surfaced_at": "2019-08-24T14:15:22Z", "evidence_started_at": "2019-08-24T14:15:22Z", "evidence_ended_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "cursor": "string" }}