Skip to main content
GET
ListRecommendations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

targetKinds
enum<string>[]

Limit the list to these kinds of target. Empty lists every kind.

RecommendationTargetKind names a kind of target, for filtering.

Available options:
RECOMMENDATION_TARGET_KIND_UNSPECIFIED,
RECOMMENDATION_TARGET_KIND_WORKSPACE,
RECOMMENDATION_TARGET_KIND_INTEGRATION
integrationIds
string<uuid>[]

Limit the list to recommendations about these integrations (UUIDs). Implies the integration target kind. Empty applies no integration filter.

Maximum array length: 200
states
enum<string>[]

Limit the list to recommendations in these states. Empty lists every state; pass RECOMMENDATION_STATE_OPEN for the ones still in front of you.

RecommendationState is whether a recommendation is in front of you.

Available options:
RECOMMENDATION_STATE_UNSPECIFIED,
RECOMMENDATION_STATE_OPEN,
RECOMMENDATION_STATE_DISMISSED,
RECOMMENDATION_STATE_IGNORED
pagination.cursor
string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize
integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0

Response

200 - application/json

Success

Response with a page of recommendation ids.

recommendationIds
string[]
pageInfo
PageInfo · object

Pass page_info.last_id as the next cursor. Empty once there are no more.