---
title: "Get the \"Note to self\" conversation for the user"
method: GET
path: "/ocs/v2.php/apps/spreed/api/{apiVersion}/room/note-to-self"
tags: ["room"]
---

# Get the "Note to self" conversation for the user

`GET /ocs/v2.php/apps/spreed/api/{apiVersion}/room/note-to-self`

It will be automatically created when it is currently missing

## Path parameters

- `apiVersion` 'v4', required

## Headers

- `OCS-APIRequest` boolean, required

## Response `200`

Room returned successfully

- object
  - `ocs` object, required
    - `meta` OCSMeta, required
      - `status` string, required
      - `statuscode` integer, required
      - `message` string
      - `totalitems` string
      - `itemsperpage` string
    - `data` Room, required
      - `actorId` string, required — The unique identifier for the given actor type
      - `invitedActorId` string — The cloud id of the invited user
      - `actorType` string, required — Actor type of the current user (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#attendee-types))
      - `attendeeId` integer, required — Unique attendee id
      - `attendeePermissions` integer, required — Dedicated permissions for the current participant, if not `Custom` this are not the resulting permissions (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#attendee-permissions))
      - `attendeePin` string, nullable, required — Unique dial-in authentication code for this user, when the conversation has SIP enabled (see `sipEnabled` attribute)
      - `avatarVersion` string, required — Version of conversation avatar used to easier expiration of the avatar in case a moderator updates it, since the avatar endpoint should be cached for 24 hours. (only available with `avatar` capability)
      - `breakoutRoomMode` integer, required — Breakout room configuration mode (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#breakout-room-modes)) (only available with `breakout-rooms-v1` capability)
      - `breakoutRoomStatus` integer, required — Breakout room status (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#breakout-room-status)) (only available with `breakout-rooms-v1` capability)
      - `callFlag` integer, required — Combined flag of all participants in the current call (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#participant-in-call-flag), only available with `conversation-call-flags` capability)
      - `callPermissions` integer, required — Call permissions, if not `Custom` this are not the resulting permissions, if set they will reset after the end of the call (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#attendee-permissions))
      - `callRecording` 0 | 1 | 2 | 3 | 4 | 5, required — Type of call recording (see [Constants - Call recording status](https://nextcloud-talk.readthedocs.io/en/latest/constants#call-recording-status)) (only available with `recording-v1` capability)
      - `callStartTime` integer, required — Timestamp when the call was started (only available with `recording-v1` capability)
      - `canDeleteConversation` boolean, required — Flag if the user can delete the conversation for everyone (not possible without moderator permissions or in one-to-one conversations)
      - `canEnableSIP` boolean, required — Whether the given user can enable SIP for this conversation. Note that when the token is not-numeric only, SIP can not be enabled even if the user is permitted and a moderator of the conversation
      - `canLeaveConversation` boolean, required — Flag if the user can leave the conversation (not possible for the last user with moderator permissions)
      - `canStartCall` boolean, required — Flag if the user can start a new call in this conversation (joining is always possible) (only available with `start-call-flag` capability)
      - `defaultPermissions` integer, required — Default permissions for new participants (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#attendee-permissions))
      - `description` string, required — Description of the conversation (can also be empty) (only available with `room-description` capability)
      - `displayName` string, required — `name` if non-empty, otherwise it falls back to a list of participants
      - `hasCall` boolean, required — Flag if the conversation has an active call
      - `hasPassword` boolean, required — Flag if the conversation has a password
      - `id` integer, required — Identifier of the conversation
      - `isCustomAvatar` boolean, required — Flag if the conversation has a custom avatar (only available with `avatar` capability)
      - `isFavorite` boolean, required — Flag if the conversation is favorited by the user
      - `lastActivity` integer, required — Timestamp of the last activity in the conversation, in seconds and UTC time zone
      - `lastCommonReadMessage` integer, required — ID of the last message read by every user that has read privacy set to public in a room. When the user themself has it set to private the value is `0` (only available with `chat-read-status` capability)
      - `lastMessage` union
        - ChatMessage
          - `actorDisplayName` string, required — Display name of the message author (can be empty for type `deleted_users` and `guests`)
          - `actorId` string, required — Actor id of the message author
          - `actorType` string, required — See [Constants - Actor types of chat messages](https://nextcloud-talk.readthedocs.io/en/latest/constants#actor-types-of-chat-messages)
          - `expirationTimestamp` integer, required — Unix time stamp when the message expires and should be removed from the clients UI without further note or warning (only available with `message-expiration` capability)
          - `message` string, required — Message string with placeholders (see [Rich Object String](https://github.com/nextcloud/server/issues/1706))
          - `messageParameters` object, required — Message parameters for `message` (see [Rich Object String](https://github.com/nextcloud/server/issues/1706))
          - `messageType` string, required — Currently known types are `comment`, `comment_deleted`, `system` and `command`
          - `systemMessage` string, required — Empty for normal chat message or the type of the system message (untranslated)
          - `deleted` true — Set to `true` when the message was deleted
          - `id` integer, required — ID of the comment
          - `isReplyable` boolean, required — True if the user can post a reply to this message (only available with `chat-replies` capability)
          - `markdown` boolean, required — Whether the message should be rendered as markdown or shown as plain text
          - `reactions` object, required — An array map with relation between reaction emoji and total count of reactions with this emoji
          - `reactionsSelf` string[] — When the user reacted this is the list of emojis the user reacted with
          - `referenceId` string, required — A reference string that was given while posting the message to be able to identify a sent message again (only available with `chat-reference-id` capability). For grouped file uploads support, expected format is `{sha256(uploadId)}-{order}`, matching /^[a-f0-9]{60}-[0-9]{3}$/
          - `timestamp` integer, required — Timestamp in seconds and UTC time zone
          - `token` string, required — Conversation token
          - `lastEditActorDisplayName` string — Display name of the last editing author (only available with `edit-messages` capability and when the message was actually edited)
          - `lastEditActorId` string — Actor id of the last editing author (only available with `edit-messages` capability and when the message was actually edited)
          - `lastEditActorType` string — Actor type of the last editing author - See [Constants - Actor types of chat messages](https://nextcloud-talk.readthedocs.io/en/latest/constants#actor-types-of-chat-messages) (only available with `edit-messages` capability and when the message was actually edited)
          - `lastEditTimestamp` integer — Unix time stamp when the message was last edited (only available with `edit-messages` capability and when the message was actually edited)
          - `silent` boolean — Whether the message was sent silently (only available with `silent-send-state` capability)
          - `threadId` integer — Thread ID if this message is part of a thread
          - `isThread` boolean — Whether this message is the root of a thread
          - `threadTitle` string — Title of the thread if this message is the root of a thread
          - `threadReplies` integer — Number of replies in the thread if this message is the root of a thread
          - `metaData` ChatMessageMetaData
            - `pinnedActorType` string — Actor type of the attendee that pinned the message - Required capability: `pinned-messages`
            - `pinnedActorId` string — Actor ID of the attendee that pinned the message - Required capability: `pinned-messages`
            - `pinnedActorDisplayName` string — Display name of the attendee that pinned the message - Required capability: `pinned-messages`
            - `pinnedAt` integer — Timestamp when the message was pinned - Required capability: `pinned-messages`
            - `pinnedUntil` integer — Timestamp until when the message is pinned. If missing the message is pinned infinitely - Required capability: `pinned-messages`
            - `threadId` integer — Set when a thread is created with this message. If missing, no thread creation is associated with this message
            - `threadTitle` string — Set when a thread is created with this message. If missing, no thread creation is associated with this message
            - `replyToMessageId` integer — Set only when a message in a convo is private replied on a 1-1 room. Represents the parent message id
            - `replyToConversationToken` string — Set only when a message in a convo is private replied on a 1-1 room. Represents the parent message's group conversation token.
            - `replyToConversationName` string — Set only when a message in a convo is private replied on a 1-1 room. Represents the parent message's group conversation name
            - `replyToActorDisplayName` string — Set only when a message in a convo is private replied on a 1-1 room. Represents the parent message's actor display name
        - ChatProxyMessage
          - `actorDisplayName` string, required — Display name of the message author (can be empty for type `deleted_users` and `guests`)
          - `actorId` string, required — Actor id of the message author
          - `actorType` string, required — See [Constants - Actor types of chat messages](https://nextcloud-talk.readthedocs.io/en/latest/constants#actor-types-of-chat-messages)
          - `expirationTimestamp` integer, required — Unix time stamp when the message expires and should be removed from the clients UI without further note or warning (only available with `message-expiration` capability)
          - `message` string, required — Message string with placeholders (see [Rich Object String](https://github.com/nextcloud/server/issues/1706))
          - `messageParameters` object, required — Message parameters for `message` (see [Rich Object String](https://github.com/nextcloud/server/issues/1706))
          - `messageType` string, required — Currently known types are `comment`, `comment_deleted`, `system` and `command`
          - `systemMessage` string, required — Empty for normal chat message or the type of the system message (untranslated)
      - `lastPing` integer, required — Timestamp of the user's session making the request
      - `lastReadMessage` integer, required — ID of the last read message in a room (only available with `chat-read-marker` capability)
      - `listable` integer, required — Listable scope for the room (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#listable-scope)) (only available with `listable-rooms` capability)
      - `liveTranscriptionLanguageId` string, required — ID of the language to use for live transcriptions in the room,
      - `lobbyState` integer, required — Webinar lobby restriction (0-1), if the participant is a moderator they can always join the conversation (only available with `webinary-lobby` capability) (See [Webinar lobby states](https://nextcloud-talk.readthedocs.io/en/latest/constants#webinar-lobby-states))
      - `lobbyTimer` integer, required — Timestamp when the lobby will be automatically disabled (only available with `webinary-lobby` capability)
      - `mentionPermissions` 0 | 1, required — Whether all participants can mention using `@all` or only moderators (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#mention-permissions)) (only available with `mention-permissions` capability)
      - `messageExpiration` integer, required — The message expiration time in seconds in this chat. Zero if disabled. (only available with `message-expiration` capability)
      - `name` string, required — Name of the conversation (can also be empty)
      - `notificationCalls` integer, required — The call notification level for the user (see [Participant call notification levels](https://nextcloud-talk.readthedocs.io/en/latest/constants#participant-call-notification-levels))
      - `notificationLevel` integer, required — The notification level for the user (See [Participant notification levels](https://nextcloud-talk.readthedocs.io/en/latest/constants#participant-notification-levels))
      - `objectId` string, required — See [Object types](https://nextcloud-talk.readthedocs.io/en/latest/constants#object-types) documentation for explanation
      - `objectType` string, required — The type of object that the conversation is associated with (See [Object types](https://nextcloud-talk.readthedocs.io/en/latest/constants#object-types))
      - `participantFlags` integer, required — "In call" flags of the user's session making the request (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#participant-in-call-flag)) (only available with `in-call-flags` capability)
      - `participantType` integer, required — Permissions level of the current user (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#participant-types))
      - `permissions` integer, required — Combined final permissions for the current participant, permissions are picked in order of attendee then call then default and the first which is `Custom` will apply (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#attendee-permissions))
      - `readOnly` integer, required — Read-only state for the current user (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#read-only-states)) (only available with `read-only-rooms` capability)
      - `recordingConsent` integer, required — Whether recording consent is required before joining a call (Only 0 and 1 will be returned, see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#recording-consent-required)) (only available with `recording-consent` capability)
      - `remoteServer` string
      - `remoteToken` string
      - `sessionId` string, required — `'0'` if not connected, otherwise an up to 512 character long string that is the identifier of the user's session making the request. Should only be used to pre-check if the user joined already with this session, but this might be outdated by the time of usage, so better check via [Get list of participants in a conversation](https://nextcloud-talk.readthedocs.io/en/latest/participant/#get-list-of-participants-in-a-conversation)
      - `sipEnabled` integer, required — SIP enable status (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#sip-states))
      - `status` string — Only available for one-to-one conversations, when `includeStatus=true` is set and the user has a status
      - `statusClearAt` integer, nullable — Only available for one-to-one conversations, when `includeStatus=true` is set and the user has a status, can still be null even with a status
      - `statusIcon` string, nullable — Only available for one-to-one conversations, when `includeStatus=true` is set and the user has a status, can still be null even with a status
      - `statusMessage` string, nullable — Only available for one-to-one conversations, when `includeStatus=true` is set and the user has a status, can still be null even with a status
      - `token` string, required — Token identifier of the conversation which is used for further interaction
      - `type` integer, required — See list of conversation types in the [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants/#conversation-types)
      - `unreadMention` boolean, required — Flag if the user was mentioned since their last visit
      - `unreadMentionDirect` boolean, required — Flag if the user was mentioned directly (ignoring `@all` mentions) since their last visit (only available with `direct-mention-flag` capability)
      - `unreadMessages` integer, required — Number of unread chat messages in the conversation (only available with `chat-v2` capability)
      - `isArchived` boolean, required — Flag if the conversation is archived by the user (only available with `archived-conversations-v2` capability)
      - `isImportant` boolean, required — Required capability: `important-conversations`
      - `isSensitive` boolean, required — Required capability: `sensitive-conversations`
      - `tagIds` string[], required — IDs of the custom tags this conversation is marked with (only available with `conversation-tags` capability)
      - `lastPinnedId` integer, required — Required capability: `pinned-messages`
      - `hiddenPinnedId` integer, required — Required capability: `pinned-messages`
      - `hasScheduledMessages` integer, required — Required capability: `scheduled-messages` (local)
      - `attributes` integer, required — Bit-flag of enabled attributes of this conversation (only available with capability: `conversation-attributes`). See [attributes list](https://nextcloud-talk.readthedocs.io/en/latest/constants/#conversation-attributes) for details

## Other responses

- `401` — Current user is not logged in

## Changes

- **2026-04-29** `89621cb42013` — 1 info
  - added the required property `ocs/data/tagIds` to the response with the `200` status
- **2026-04-27** `812935981d69` — 1 breaking
  - removed the required property `ocs/data/tagIds` from the response with the `200` status
- **2026-04-26** `7e78681bf716` — 1 info
  - added the required property `ocs/data/tagIds` to the response with the `200` status
- **2026-03-31** `dc2b6567a07b` — 4 info
  - added the optional property `ocs/data/lastMessage/anyOf[#/components/schemas/ChatMessage]/allOf[subschema #2]/metaData/replyToActorDisplayName` to the response with the `200` status
  - added the optional property `ocs/data/lastMessage/anyOf[#/components/schemas/ChatMessage]/allOf[subschema #2]/metaData/replyToConversationName` to the response with the `200` status
  - added the optional property `ocs/data/lastMessage/anyOf[#/components/schemas/ChatMessage]/allOf[subschema #2]/metaData/replyToConversationToken` to the response with the `200` status
  - added the optional property `ocs/data/lastMessage/anyOf[#/components/schemas/ChatMessage]/allOf[subschema #2]/metaData/replyToMessageId` to the response with the `200` status
- **2026-02-19** `99bd41590ecb` — 1 info
  - added the required property `ocs/data/attributes` to the response with the `200` status

[Full history](https://skmtc.dev/nextcloud/apis/spreed-full/changes/ocs/v2.php/apps/spreed/api/:apiVersion/room/note-to-self/get.md)

---

[API](https://skmtc.dev/nextcloud/apis/spreed-full.md) · [All operations](https://skmtc.dev/nextcloud/apis/spreed-full/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nextcloud/spreed-full/revisions/41d6458d6d6e/schema)