DocumentationAPI reference

Rust · 0.1.0

Get Shared Memo

GET /api/v1/shares/{shareToken}/memo

MemoService · MemoService_GetSharedMemo

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

No bearer token is required, including on a private instance. The share token itself is a read-only access grant. Treat it as a secret and revoke the share when it is no longer needed.

Expired and unavailable shares

Invalid or expired tokens, archived memos and SPACE-audience memos return NOT_FOUND. A share response is a restricted projection and does not disclose the memo's relation graph. Do not interpret a successful share read as permission to call authenticated write endpoints.

Request

GetSharedMemo resolves a share token to its memo. No authentication required. Returns NOT_FOUND if the token is invalid or expired.

GET/api/v1/shares/{shareToken}/memo

Parameters

Name / locationType / requirementDescription
shareToken
path
string
Required
Required. The opaque bearer token extracted from the share URL.

Request body

No request body is declared.

Responses

200 · OK

application/json · Memo

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition
{
  "tags": [
    "MemoService"
  ],
  "description": "GetSharedMemo resolves a share token to its memo. No authentication required.\n Returns NOT_FOUND if the token is invalid or expired.",
  "operationId": "MemoService_GetSharedMemo",
  "parameters": [
    {
      "name": "shareToken",
      "in": "path",
      "description": "Required. The opaque bearer token extracted from the share URL.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Memo"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}