Memos unofficial
GET/api/v1/memos/{memo}

Get a memo

Retrieves a memo by its identifier. Use the memo path parameter to specify which memo to retrieve.

1 parameter
memostringrequired
The identifier of the memo to retrieve.

2 status codes
200Returns the memo resource, including its content, visibility, state, and available attachments, relations, and reactions.
namestringoptional
The resource name of the memo. Format: memos/{memo}, where memo is the user-defined UID.
statestringrequired
The state of the memo.
Allowed:STATE_UNSPECIFIEDNORMALARCHIVED
creatorstringoptional
The name of the creator. Format: users/{user}
createTimestringoptional
The creation timestamp. If not set on creation, the server will set it to the current time.
updateTimestringoptional
The last update timestamp. If not set on creation, the server will set it to the current time.
contentstringrequired
Required. The content of the memo in Markdown format.
visibilitystringrequired
The visibility of the memo. One of PRIVATE (creator only), PROTECTED (signed-in users), PUBLIC (anonymous-eligible), or SPACE (active space members). Defaults to PRIVATE on creation when unspecified.
Allowed:VISIBILITY_UNSPECIFIEDPRIVATEPROTECTEDPUBLICSPACE
tagsarray<string>optional
Output only. The tags extracted from the content.
pinnedbooleanoptional
Whether the memo is pinned.
attachmentsarray<object>optional
Optional. The attachments of the memo.
relationsarray<object>optional
Optional. The relations of the memo.
reactionsarray<object>optional
Output only. The reactions to the memo.
propertyobjectoptional
Output only. The computed properties of the memo.
parentstringoptional
Output only. The context memo of this COMMENT relation, if any. Its identity is returned even when the caller cannot read the parent. Fetch the parent independently; this field does not grant read access. Format: memos/{memo}
snippetstringoptional
Output only. The snippet of the memo content. Plain text only.
locationobjectoptional
Optional. The location of the memo.
spacestringoptional
Optional. The space in which this memo is placed. Format: spaces/{space}. Every memo, including a comment, owns its placement independently.
defaultReturned when the request fails; includes an error code, a developer-facing message, and optional error details.
codeintegeroptional
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringoptional
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarray<object>optional
A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

The memo path parameter must identify the memo you want to retrieve.