Sign in
MemoService

ListMemos lists memos with pagination and filter.

get/api/v1/memos

Query parameters

pageSizeinteger

Optional. The maximum number of memos to return. The service may return fewer than this value. If unspecified, at most 50 memos will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

Optional. A page token, received from a previous ListMemos call. Provide this to retrieve the subsequent page.

state'STATE_UNSPECIFIED' | 'NORMAL' | 'ARCHIVED' enum

Optional. The state of the memos to list. Default to NORMAL. Set to ARCHIVED to list archived memos.

orderBystring

Optional. The order to sort results by. Default to "display_time desc". Supports comma-separated list of fields following AIP-132. Example: "pinned desc, display_time desc" or "create_time asc" Supported fields: pinned, display_time, create_time, update_time, name

filterstring

Optional. Filter to apply to the list results. Filter is a CEL expression to filter memos. Refer to Shortcut.filter.

showDeletedboolean

Optional. If true, show deleted memos in the response.

Response

OK

nextPageTokenstring

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Changes