--- title: "Get multiple users using ids" method: GET path: "/wiki/rest/api/user/bulk" tags: ["Users"] --- # Get multiple users using ids `GET /wiki/rest/api/user/bulk` Returns user details for the ids provided in the request. Currently this API returns a maximum of 100 results. If more than 100 account ids are passed in, then the first 100 will be returned. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). ## Query parameters - `accountId` string, required - `expand` string[] ## Response `200` Returned if, the list of users is returned. - BulkUserLookupArray - `results` BulkUserLookup[], required - `type` 'known' | 'unknown' | 'anonymous' | 'user', required - `username` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `userKey` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `accountId` string, nullable, required — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. - `accountType` string, required — The account type of the user, may return empty string if unavailable. - `email` string, required — The email address of the user. Depending on the user's privacy setting, this may return an empty string. - `publicName` string, required — The public name or nickname of the user. Will always contain a value. - `profilePicture` Icon, nullable, required — This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. - `path` string, required - `width` integer, required - `height` integer, required - `isDefault` boolean, required - `displayName` string, required — The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. - `timeZone` string, nullable — This displays user time zone. Depending on the user's privacy setting, this may return null. - `isExternalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isGuest` boolean — Whether the user is a guest user - `operations` OperationCheckResult[] - `operation` 'administer' | 'archive' | 'clear_permissions' | 'copy' | 'create' | 'create_space' | 'delete' | 'export' | 'move' | 'purge' | 'purge_version' | 'read' | 'restore' | 'restrict_content' | 'update' | 'use', required — The operation itself. - `targetType` string, required — The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space - `details` UserDetails - `business` object - `position` string — This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `department` string — This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `location` string — This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `personal` object - `phone` string — This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `im` string — This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `website` string — This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `email` string — This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `personalSpace` Space, nullable - `id` integer - `key` string, required - `alias` string - `name` string, required - `icon` Icon, nullable — This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. - `path` string, required - `width` integer, required - `height` integer, required - `isDefault` boolean, required - `description` object - `plain` SpaceDescription - `value` string, required - `representation` 'plain' | 'view', required - `embeddedContent` object[], required - `view` SpaceDescription - `value` string, required - `representation` 'plain' | 'view', required - `embeddedContent` object[], required - `_expandable` object - `view` string - `plain` string - `homepage` Content, nullable — Base object for all content types. - `id` string - `type` string, required — Can be "page", "blogpost", "attachment" or "content" - `status` string, required - `title` string - `space` Space — recursive - `history` ContentHistory, nullable - `latest` boolean, required - `createdBy` User, nullable - `type` 'known' | 'unknown' | 'anonymous' | 'user', required - `username` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `userKey` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `accountId` string, nullable — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. - `accountType` 'atlassian' | 'app' | '' — The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app. - `email` string, nullable — The email address of the user. Depending on the user's privacy setting, this may return an empty string. - `publicName` string — The public name or nickname of the user. Will always contain a value. - `profilePicture` Icon, nullable — This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. - … - `displayName` string, nullable — The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. - `timeZone` string, nullable — This displays user time zone. Depending on the user's privacy setting, this may return null. - `externalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isExternalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isGuest` boolean — Whether the user is a guest user - `operations` OperationCheckResult[], nullable - … - `details` UserDetails - … - `personalSpace` Space — recursive - `_expandable` object - … - `_links` GenericLinks - `ownedBy` User, nullable - `type` 'known' | 'unknown' | 'anonymous' | 'user', required - `username` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `userKey` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `accountId` string, nullable — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. - `accountType` 'atlassian' | 'app' | '' — The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app. - `email` string, nullable — The email address of the user. Depending on the user's privacy setting, this may return an empty string. - `publicName` string — The public name or nickname of the user. Will always contain a value. - `profilePicture` Icon, nullable — This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. - … - `displayName` string, nullable — The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. - `timeZone` string, nullable — This displays user time zone. Depending on the user's privacy setting, this may return null. - `externalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isExternalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isGuest` boolean — Whether the user is a guest user - `operations` OperationCheckResult[], nullable - … - `details` UserDetails - … - `personalSpace` Space — recursive - `_expandable` object - … - `_links` GenericLinks - `lastOwnedBy` User, nullable - `type` 'known' | 'unknown' | 'anonymous' | 'user', required - `username` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `userKey` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `accountId` string, nullable — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. - `accountType` 'atlassian' | 'app' | '' — The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app. - `email` string, nullable — The email address of the user. Depending on the user's privacy setting, this may return an empty string. - `publicName` string — The public name or nickname of the user. Will always contain a value. - `profilePicture` Icon, nullable — This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. - … - `displayName` string, nullable — The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. - `timeZone` string, nullable — This displays user time zone. Depending on the user's privacy setting, this may return null. - `externalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isExternalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isGuest` boolean — Whether the user is a guest user - `operations` OperationCheckResult[], nullable - … - `details` UserDetails - … - `personalSpace` Space — recursive - `_expandable` object - … - `_links` GenericLinks - `createdDate` string, date-time - `lastUpdated` Version, nullable - `by` User, nullable - … - `when` string, date-time, nullable, required - `friendlyWhen` string, nullable - `message` string, nullable - `number` integer, required — Set this to the current version number incremented by one - `minorEdit` boolean, required — If `minorEdit` is set to 'true', no notification email or activity stream will be generated for the change. - `content` Content — recursive - `collaborators` UsersUserKeys, nullable - … - `_expandable` object - … - `_links` GenericLinks - `contentTypeModified` boolean — True if content type is modifed in this version (e.g. page to blog) - `confRev` string, nullable — The revision id provided by confluence to be used as a revision in Synchrony - `syncRev` string, nullable — The revision id provided by Synchrony - `syncRevSource` string, nullable — Source of the synchrony revision - `previousVersion` Version, nullable - `by` User, nullable - … - `when` string, date-time, nullable, required - `friendlyWhen` string, nullable - `message` string, nullable - `number` integer, required — Set this to the current version number incremented by one - `minorEdit` boolean, required — If `minorEdit` is set to 'true', no notification email or activity stream will be generated for the change. - `content` Content — recursive - `collaborators` UsersUserKeys, nullable - … - `_expandable` object - … - `_links` GenericLinks - `contentTypeModified` boolean — True if content type is modifed in this version (e.g. page to blog) - `confRev` string, nullable — The revision id provided by confluence to be used as a revision in Synchrony - `syncRev` string, nullable — The revision id provided by Synchrony - `syncRevSource` string, nullable — Source of the synchrony revision - `contributors` object - `publishers` UsersUserKeys, nullable - … - `nextVersion` Version, nullable - `by` User, nullable - … - `when` string, date-time, nullable, required - `friendlyWhen` string, nullable - `message` string, nullable - `number` integer, required — Set this to the current version number incremented by one - `minorEdit` boolean, required — If `minorEdit` is set to 'true', no notification email or activity stream will be generated for the change. - `content` Content — recursive - `collaborators` UsersUserKeys, nullable - … - `_expandable` object - … - `_links` GenericLinks - `contentTypeModified` boolean — True if content type is modifed in this version (e.g. page to blog) - `confRev` string, nullable — The revision id provided by confluence to be used as a revision in Synchrony - `syncRev` string, nullable — The revision id provided by Synchrony - `syncRevSource` string, nullable — Source of the synchrony revision - `_expandable` object - `lastUpdated` string - `previousVersion` string - `contributors` string - `nextVersion` string - `ownedBy` string - `lastOwnedBy` string - `_links` GenericLinks - `version` Version, nullable - `by` User, nullable - `type` 'known' | 'unknown' | 'anonymous' | 'user', required - `username` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `userKey` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `accountId` string, nullable — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. - `accountType` 'atlassian' | 'app' | '' — The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app. - `email` string, nullable — The email address of the user. Depending on the user's privacy setting, this may return an empty string. - `publicName` string — The public name or nickname of the user. Will always contain a value. - `profilePicture` Icon, nullable — This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. - … - `displayName` string, nullable — The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. - `timeZone` string, nullable — This displays user time zone. Depending on the user's privacy setting, this may return null. - `externalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isExternalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isGuest` boolean — Whether the user is a guest user - `operations` OperationCheckResult[], nullable - … - `details` UserDetails - … - `personalSpace` Space — recursive - `_expandable` object - … - `_links` GenericLinks - `when` string, date-time, nullable, required - `friendlyWhen` string, nullable - `message` string, nullable - `number` integer, required — Set this to the current version number incremented by one - `minorEdit` boolean, required — If `minorEdit` is set to 'true', no notification email or activity stream will be generated for the change. - `content` Content — recursive - `collaborators` UsersUserKeys, nullable - `users` User[] - … - `userKeys` string[] - `_links` GenericLinks - `_expandable` object - `content` string - `collaborators` string - `_links` GenericLinks - `contentTypeModified` boolean — True if content type is modifed in this version (e.g. page to blog) - `confRev` string, nullable — The revision id provided by confluence to be used as a revision in Synchrony - `syncRev` string, nullable — The revision id provided by Synchrony - `syncRevSource` string, nullable — Source of the synchrony revision - `ancestors` Content[], nullable - `operations` OperationCheckResult[] - `operation` 'administer' | 'archive' | 'clear_permissions' | 'copy' | 'create' | 'create_space' | 'delete' | 'export' | 'move' | 'purge' | 'purge_version' | 'read' | 'restore' | 'restrict_content' | 'update' | 'use', required — The operation itself. - `targetType` string, required — The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space - `children` ContentChildren - `attachment` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `comment` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `page` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `whiteboard` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `database` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `embed` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `folder` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `_expandable` object - `attachment` string - `comment` string - `page` string - `whiteboard` string - `database` string - `embed` string - `folder` string - `_links` GenericLinks - `childTypes` ContentChildType — Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects. - `attachment` object - `value` boolean, required - `_links` GenericLinks, required - `comment` object - `value` boolean, required - `_links` GenericLinks, required - `page` object - `value` boolean, required - `_links` GenericLinks, required - `_expandable` object - `all` string - `attachment` string - `comment` string - `page` string - `whiteboard` string - `database` string - `embed` string - `folder` string - `descendants` ContentChildren - `attachment` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `comment` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `page` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `whiteboard` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `database` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `embed` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `folder` ContentArray - `results` Content[], required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks, required - `_expandable` object - `attachment` string - `comment` string - `page` string - `whiteboard` string - `database` string - `embed` string - `folder` string - `_links` GenericLinks - `container` Container, nullable — Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment) - `body` object - `view` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `export_view` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `styled_view` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `storage` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `wiki` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `editor` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `editor2` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `anonymous_export_view` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `atlas_doc_format` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `dynamic` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `raw` ContentBody - `value` string, required - `representation` 'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format' | 'raw', required - `embeddedContent` EmbeddedContent[] - … - `webresource` WebResourceDependencies - … - `mediaToken` object - … - `_expandable` object - … - `_links` GenericLinks - `_expandable` object - `editor` string - `view` string - `export_view` string - `styled_view` string - `storage` string - `editor2` string - `anonymous_export_view` string - `atlas_doc_format` string - `wiki` string - `dynamic` string - `raw` string - `restrictions` object - `read` ContentRestriction - `operation` 'administer' | 'copy' | 'create' | 'delete' | 'export' | 'move' | 'purge' | 'purge_version' | 'read' | 'restore' | 'update' | 'use', required - `restrictions` object - … - `content` Content — recursive - `_expandable` object, required - … - `_links` GenericLinks, required - `update` ContentRestriction - `operation` 'administer' | 'copy' | 'create' | 'delete' | 'export' | 'move' | 'purge' | 'purge_version' | 'read' | 'restore' | 'update' | 'use', required - `restrictions` object - … - `content` Content — recursive - `_expandable` object, required - … - `_links` GenericLinks, required - `_expandable` object - `read` string - `update` string - `_links` GenericLinks - `metadata` ContentMetadata — Metadata object for page, blogpost, comment content - `currentuser` object - `favourited` object - … - `lastmodified` object - … - `lastcontributed` object - … - `viewed` object - … - `scheduled` object - `_expandable` object - … - `properties` GenericLinks - `frontend` object - `labels` union - LabelArray - … - Label[] - … - `macroRenderedOutput` object - `extensions` object - `_expandable` object - `childTypes` string - `container` string - `metadata` string - `operations` string - `children` string - `restrictions` string - `history` string - `ancestors` string - `body` string - `version` string - `descendants` string - `space` string - `extensions` string - `schedulePublishDate` string - `schedulePublishInfo` string - `macroRenderedOutput` string - `_links` GenericLinks - `type` string, required - `metadata` object - `labels` LabelArray - `results` Label[], required - `prefix` string, required - `name` string, required - `id` string, required - `label` string, required - `start` integer - `limit` integer - `size` integer, required - `_links` GenericLinks - `_expandable` object - `operations` OperationCheckResult[] - `operation` 'administer' | 'archive' | 'clear_permissions' | 'copy' | 'create' | 'create_space' | 'delete' | 'export' | 'move' | 'purge' | 'purge_version' | 'read' | 'restore' | 'restrict_content' | 'update' | 'use', required — The operation itself. - `targetType` string, required — The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space - `permissions` SpacePermission[] - `id` integer - `subjects` object — The users and/or groups that the permission applies to. - `user` object - `results` User[], required - … - `size` integer, required - `start` integer - `limit` integer - `group` object - `results` Group[], required - … - `size` integer, required - `start` integer - `limit` integer - `_expandable` object - `user` string - `group` string - `operation` OperationCheckResult, required — An operation and the target entity that it applies to, e.g. create page. - `operation` 'administer' | 'archive' | 'clear_permissions' | 'copy' | 'create' | 'create_space' | 'delete' | 'export' | 'move' | 'purge' | 'purge_version' | 'read' | 'restore' | 'restrict_content' | 'update' | 'use', required — The operation itself. - `targetType` string, required — The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space - `anonymousAccess` boolean, required — Grant anonymous users permission to use the operation. - `unlicensedAccess` boolean, required — Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation. - `status` string, required - `settings` SpaceSettings, nullable - `routeOverrideEnabled` boolean, required — Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home. - `editor` object - `page` string, required - `blogpost` string, required - `default` string, required - `contentMode` 'standard' | 'compact', nullable — The content rendering mode for the space. Controls spacing and typography in the editor and renderer. Valid values are "standard" and "compact". When set to "compact", content is rendered more densely with smaller spacing and typography. - `spaceKey` string - `_links` GenericLinks, required - `theme` Theme - `themeKey` string, required - `name` string - `description` string - `icon` Icon, nullable — This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. - `path` string, required - `width` integer, required - `height` integer, required - `isDefault` boolean, required - `_links` GenericLinks - `lookAndFeel` LookAndFeel - `headings` object, required - `color` string, required - `links` object, required - `color` string, required - `menus` MenusLookAndFeel, required - `hoverOrFocus` object, required - `backgroundColor` string, required - `color` string, required - `header` HeaderLookAndFeel, required - `backgroundColor` string, required - `button` ButtonLookAndFeel, nullable, required - `backgroundColor` string, required - `color` string, required - `primaryNavigation` NavigationLookAndFeel, nullable, required - `color` string, required - `highlightColor` string, nullable - `hoverOrFocus` object, required - … - `secondaryNavigation` NavigationLookAndFeel, nullable, required - `color` string, required - `highlightColor` string, nullable - `hoverOrFocus` object, required - … - `search` SearchFieldLookAndFeel, nullable, required - `backgroundColor` string, required - `color` string, required - `horizontalHeader` HorizontalHeaderLookAndFeel - `backgroundColor` string, required - `button` ButtonLookAndFeel, nullable - `backgroundColor` string, required - `color` string, required - `primaryNavigation` TopNavigationLookAndFeel, required - `color` string, nullable - `highlightColor` string, required - `hoverOrFocus` object - … - `secondaryNavigation` NavigationLookAndFeel, nullable - `color` string, required - `highlightColor` string, nullable - `hoverOrFocus` object, required - … - `search` SearchFieldLookAndFeel, nullable - `backgroundColor` string, required - `color` string, required - `content` ContentLookAndFeel, required - `screen` ScreenLookAndFeel - `background` string, required - `backgroundAttachment` string, nullable - `backgroundBlendMode` string, nullable - `backgroundClip` string, nullable - `backgroundColor` string, nullable - `backgroundImage` string, nullable - `backgroundOrigin` string, nullable - `backgroundPosition` string, nullable - `backgroundRepeat` string, nullable - `backgroundSize` string, nullable - `layer` object, nullable - … - `gutterTop` string, nullable - `gutterRight` string, nullable - `gutterBottom` string, nullable - `gutterLeft` string, nullable - `container` ContainerLookAndFeel, nullable - `background` string, required - `backgroundAttachment` string, nullable - `backgroundBlendMode` string, nullable - `backgroundClip` string, nullable - `backgroundColor` string, nullable, required - `backgroundImage` string, nullable, required - `backgroundOrigin` string, nullable - `backgroundPosition` string, nullable - `backgroundRepeat` string, nullable - `backgroundSize` string, nullable, required - `padding` string, required - `borderRadius` string, required - `header` ContainerLookAndFeel, nullable - `background` string, required - `backgroundAttachment` string, nullable - `backgroundBlendMode` string, nullable - `backgroundClip` string, nullable - `backgroundColor` string, nullable, required - `backgroundImage` string, nullable, required - `backgroundOrigin` string, nullable - `backgroundPosition` string, nullable - `backgroundRepeat` string, nullable - `backgroundSize` string, nullable, required - `padding` string, required - `borderRadius` string, required - `body` ContainerLookAndFeel, nullable - `background` string, required - `backgroundAttachment` string, nullable - `backgroundBlendMode` string, nullable - `backgroundClip` string, nullable - `backgroundColor` string, nullable, required - `backgroundImage` string, nullable, required - `backgroundOrigin` string, nullable - `backgroundPosition` string, nullable - `backgroundRepeat` string, nullable - `backgroundSize` string, nullable, required - `padding` string, required - `borderRadius` string, required - `bordersAndDividers` object, required - `color` string, required - `spaceReference` object, nullable - `history` object - `createdDate` string, date-time, required - `createdBy` User, nullable - `type` 'known' | 'unknown' | 'anonymous' | 'user', required - `username` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `userKey` string, nullable — This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - `accountId` string, nullable — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. - `accountType` 'atlassian' | 'app' | '' — The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app. - `email` string, nullable — The email address of the user. Depending on the user's privacy setting, this may return an empty string. - `publicName` string — The public name or nickname of the user. Will always contain a value. - `profilePicture` Icon, nullable — This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. - `path` string, required - `width` integer, required - `height` integer, required - `isDefault` boolean, required - `displayName` string, nullable — The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. - `timeZone` string, nullable — This displays user time zone. Depending on the user's privacy setting, this may return null. - `externalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isExternalCollaborator` boolean — This is deprecated. Use `isGuest` instead to find out whether the user is a guest user. - `isGuest` boolean — Whether the user is a guest user - `operations` OperationCheckResult[], nullable - `operation` 'administer' | 'archive' | 'clear_permissions' | 'copy' | 'create' | 'create_space' | 'delete' | 'export' | 'move' | 'purge' | 'purge_version' | 'read' | 'restore' | 'restrict_content' | 'update' | 'use', required — The operation itself. - `targetType` string, required — The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space - `details` UserDetails - `business` object - … - `personal` object - … - `personalSpace` Space — recursive - `_expandable` object - `operations` string - `details` string - `personalSpace` string - `_links` GenericLinks - `_expandable` object, required - `settings` string - `metadata` string - `operations` string - `lookAndFeel` string - `permissions` string - `icon` string - `description` string - `theme` string - `history` string - `homepage` string - `identifiers` string - `_links` GenericLinks, required - `_expandable` object, required - `operations` string - `details` string - `personalSpace` string - `_links` GenericLinks, required - `start` integer, required - `limit` integer, required - `size` integer, required - `_links` GenericLinks, required ## Other responses - `403` — Returned if the calling user does not have permission to use Confluence. --- [API](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-confluence-cloud-rest-api/versions/70088490f406/schema)