--- title: "Get a folder." method: GET path: "/folders/{folderId}.json" tags: ["Folders"] --- # Get a folder. `GET /folders/{folderId}.json` ## Request - Base URL: `https://passbolt.local` - URL: `https://passbolt.local/folders/{folderId}.json` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `folderId` string, uuid, required ## Query parameters - `contain[children_resources]` 1 | 0 - `contain[children_folders]` 1 | 0 - `contain[creator]` 1 | 0 - `contain[creator.profile]` 1 | 0 - `contain[modifier]` 1 | 0 - `contain[modifier.profile]` 1 | 0 - `contain[permission]` 1 | 0 - `contain[permissions]` 1 | 0 - `contain[permissions.user.profile]` 1 | 0 - `contain[permissions.group]` 1 | 0 - `filter[has-id]` string, uuid ## Response `200` Operation is successful - object - `header` Header, required - `id` string, uuid, required - `status` 'success' | 'error', required - `servertime` integer, required - `action` string, uuid, required - `message` string, required - `url` string, uri, required - `code` integer, required - `body` union, required - FolderV4IndexAndView - `id` string, uuid, required - `name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `folder_parent_id` string, uuid, required - `personal` boolean, required - `modifier` UserIndexAndView - `is_mfa_enabled` boolean - `id` string, uuid, required - `role_id` string, uuid, required - `username` string, required - `active` boolean, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `disabled` string, date-time, required - `profile` object - `id` string, uuid, required - `user_id` string, uuid, required - `first_name` string, required - `last_name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `avatar` object, required - `id` string, uuid - `profile_id` string, uuid - `created` string, date-time - `modified` string, date-time - `url` object, required - … - `groups_users` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView (recursive) - `gpgkey` Gpgkey - `id` string, uuid, required - `user_id` string, uuid, required - `armored_key` string, required - `bits` integer, required - `uid` string, required - `key_id` string, required - `fingerprint` string, required - `type` 'RSA' | 'ECC', required - `expires` string, date-time, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `role` Role - `id` string, uuid, required - `name` 'admin' | 'guest' | 'user', required - `description` string, required - `created` string, date-time, required - `modified` string, date-time, required - `missing_metadata_key_ids` string[] - `last_logged_in` string, date-time - `creator` UserIndexAndView - `is_mfa_enabled` boolean - `id` string, uuid, required - `role_id` string, uuid, required - `username` string, required - `active` boolean, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `disabled` string, date-time, required - `profile` object - `id` string, uuid, required - `user_id` string, uuid, required - `first_name` string, required - `last_name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `avatar` object, required - `id` string, uuid - `profile_id` string, uuid - `created` string, date-time - `modified` string, date-time - `url` object, required - … - `groups_users` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView (recursive) - `gpgkey` Gpgkey - `id` string, uuid, required - `user_id` string, uuid, required - `armored_key` string, required - `bits` integer, required - `uid` string, required - `key_id` string, required - `fingerprint` string, required - `type` 'RSA' | 'ECC', required - `expires` string, date-time, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `role` Role - `id` string, uuid, required - `name` 'admin' | 'guest' | 'user', required - `description` string, required - `created` string, date-time, required - `modified` string, date-time, required - `missing_metadata_key_ids` string[] - `last_logged_in` string, date-time - `permission` PermissionIndexAndView - `id` string, uuid, required - `aco` 'Resource' | 'Folder', required - `aco_foreign_key` string, uuid, required - `aro` 'User' | 'Group', required - `aro_foreign_key` string, uuid, required - `type` 1 | 7 | 15, required: * `1` - Read * `7` - Update * `15` - Owner - `created` string, date-time, required - `modified` string, date-time, required - `user` UserIndexAndView - `is_mfa_enabled` boolean - `id` string, uuid, required - `role_id` string, uuid, required - `username` string, required - `active` boolean, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `disabled` string, date-time, required - `profile` object - `id` string, uuid, required - `user_id` string, uuid, required - `first_name` string, required - `last_name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `avatar` object, required - … - `groups_users` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView (recursive) - `gpgkey` Gpgkey - `id` string, uuid, required - `user_id` string, uuid, required - `armored_key` string, required - `bits` integer, required - `uid` string, required - `key_id` string, required - `fingerprint` string, required - `type` 'RSA' | 'ECC', required - `expires` string, date-time, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `role` Role - `id` string, uuid, required - `name` 'admin' | 'guest' | 'user', required - `description` string, required - `created` string, date-time, required - `modified` string, date-time, required - `missing_metadata_key_ids` string[] - `last_logged_in` string, date-time - `group` GroupIndexAndView - `id` string, uuid, required - `name` string, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `my_group_user` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView - … - `groups_users` GroupsUsersIndexAndView[] - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView - … - `user_count` integer - `permissions` PermissionIndexAndView[] - `id` string, uuid, required - `aco` 'Resource' | 'Folder', required - `aco_foreign_key` string, uuid, required - `aro` 'User' | 'Group', required - `aro_foreign_key` string, uuid, required - `type` 1 | 7 | 15, required: * `1` - Read * `7` - Update * `15` - Owner - `created` string, date-time, required - `modified` string, date-time, required - `user` UserIndexAndView - `is_mfa_enabled` boolean - `id` string, uuid, required - `role_id` string, uuid, required - `username` string, required - `active` boolean, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `disabled` string, date-time, required - `profile` object - `id` string, uuid, required - `user_id` string, uuid, required - `first_name` string, required - `last_name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `avatar` object, required - … - `groups_users` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView (recursive) - `gpgkey` Gpgkey - `id` string, uuid, required - `user_id` string, uuid, required - `armored_key` string, required - `bits` integer, required - `uid` string, required - `key_id` string, required - `fingerprint` string, required - `type` 'RSA' | 'ECC', required - `expires` string, date-time, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `role` Role - `id` string, uuid, required - `name` 'admin' | 'guest' | 'user', required - `description` string, required - `created` string, date-time, required - `modified` string, date-time, required - `missing_metadata_key_ids` string[] - `last_logged_in` string, date-time - `group` GroupIndexAndView - `id` string, uuid, required - `name` string, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `my_group_user` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView - … - `groups_users` GroupsUsersIndexAndView[] - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView - … - `user_count` integer - `children_resources` union[] - union - ResourceV4IndexAndView - `id` string, uuid, required - `name` string, required - `username` string, required - `uri` string, required - `description` string, required - `deleted` boolean, required - `created` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `resource_type_id` string, uuid, required - `expired` string, date-time, required - `folder_parent_id` string, uuid, required - `personal` boolean, required - `favorite` Favorite - … - `modifier` UserIndexAndView - … - `creator` UserIndexAndView - … - `secrets` SecretIndex[] - … - `resource_type` ResourceType - … - `permission` PermissionIndexAndView - … - `permissions` PermissionIndexAndView[] - … - ResourceV5IndexAndView - `metadata` string, required: An armoured OpenPGP message. Its cleartext is a JSON object carrying an `object_type` field that names the payload, `PASSBOLT_RESOURCE_METADATA` for a resource, and the descriptive fields that used to travel in clear in the v4 format. The fields expected for a resource, and the two decryption paths, are described in the guide on working with v5 encrypted metadata. - `metadata_key_id` string, uuid, required - `metadata_key_type` 'user_key' | 'shared_key', required - `id` string, uuid, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `personal` boolean, required - `folder_parent_id` string, uuid, required - `modifier` UserIndexAndView - … - `creator` UserIndexAndView - … - `permission` PermissionIndexAndView - … - `permissions` PermissionIndexAndView[] - … - `resource_type_id` string, uuid, required - `expired` string, date-time, required - `favorite` Favorite - … - `offline` OfflineItem: The mark that makes a resource available offline for one user. It is created when the user marks the item and holds no data of its own beyond the link. - … - `secrets` SecretIndex[] - … - `resource_type` ResourceType - … - `children_folders` union[] - union - FolderV4IndexAndView (recursive) - FolderV5IndexAndView - `metadata` string, required: An armoured OpenPGP message. Its cleartext is a JSON object carrying an `object_type` field that names the payload, `PASSBOLT_RESOURCE_METADATA` for a resource, and the descriptive fields that used to travel in clear in the v4 format. The fields expected for a resource, and the two decryption paths, are described in the guide on working with v5 encrypted metadata. - `metadata_key_id` string, uuid, required - `metadata_key_type` 'user_key' | 'shared_key', required - `id` string, uuid, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `personal` boolean, required - `folder_parent_id` string, uuid, required - `modifier` UserIndexAndView - … - `creator` UserIndexAndView - … - `permission` PermissionIndexAndView - … - `permissions` PermissionIndexAndView[] - … - `children_resources` union[] - … - `children_folders` union[] - … - FolderV5IndexAndView - `metadata` string, required: An armoured OpenPGP message. Its cleartext is a JSON object carrying an `object_type` field that names the payload, `PASSBOLT_RESOURCE_METADATA` for a resource, and the descriptive fields that used to travel in clear in the v4 format. The fields expected for a resource, and the two decryption paths, are described in the guide on working with v5 encrypted metadata. - `metadata_key_id` string, uuid, required - `metadata_key_type` 'user_key' | 'shared_key', required - `id` string, uuid, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `personal` boolean, required - `folder_parent_id` string, uuid, required - `modifier` UserIndexAndView - `is_mfa_enabled` boolean - `id` string, uuid, required - `role_id` string, uuid, required - `username` string, required - `active` boolean, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `disabled` string, date-time, required - `profile` object - `id` string, uuid, required - `user_id` string, uuid, required - `first_name` string, required - `last_name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `avatar` object, required - `id` string, uuid - `profile_id` string, uuid - `created` string, date-time - `modified` string, date-time - `url` object, required - … - `groups_users` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView (recursive) - `gpgkey` Gpgkey - `id` string, uuid, required - `user_id` string, uuid, required - `armored_key` string, required - `bits` integer, required - `uid` string, required - `key_id` string, required - `fingerprint` string, required - `type` 'RSA' | 'ECC', required - `expires` string, date-time, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `role` Role - `id` string, uuid, required - `name` 'admin' | 'guest' | 'user', required - `description` string, required - `created` string, date-time, required - `modified` string, date-time, required - `missing_metadata_key_ids` string[] - `last_logged_in` string, date-time - `creator` UserIndexAndView - `is_mfa_enabled` boolean - `id` string, uuid, required - `role_id` string, uuid, required - `username` string, required - `active` boolean, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `disabled` string, date-time, required - `profile` object - `id` string, uuid, required - `user_id` string, uuid, required - `first_name` string, required - `last_name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `avatar` object, required - `id` string, uuid - `profile_id` string, uuid - `created` string, date-time - `modified` string, date-time - `url` object, required - … - `groups_users` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView (recursive) - `gpgkey` Gpgkey - `id` string, uuid, required - `user_id` string, uuid, required - `armored_key` string, required - `bits` integer, required - `uid` string, required - `key_id` string, required - `fingerprint` string, required - `type` 'RSA' | 'ECC', required - `expires` string, date-time, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `role` Role - `id` string, uuid, required - `name` 'admin' | 'guest' | 'user', required - `description` string, required - `created` string, date-time, required - `modified` string, date-time, required - `missing_metadata_key_ids` string[] - `last_logged_in` string, date-time - `permission` PermissionIndexAndView - `id` string, uuid, required - `aco` 'Resource' | 'Folder', required - `aco_foreign_key` string, uuid, required - `aro` 'User' | 'Group', required - `aro_foreign_key` string, uuid, required - `type` 1 | 7 | 15, required: * `1` - Read * `7` - Update * `15` - Owner - `created` string, date-time, required - `modified` string, date-time, required - `user` UserIndexAndView - `is_mfa_enabled` boolean - `id` string, uuid, required - `role_id` string, uuid, required - `username` string, required - `active` boolean, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `disabled` string, date-time, required - `profile` object - `id` string, uuid, required - `user_id` string, uuid, required - `first_name` string, required - `last_name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `avatar` object, required - … - `groups_users` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView (recursive) - `gpgkey` Gpgkey - `id` string, uuid, required - `user_id` string, uuid, required - `armored_key` string, required - `bits` integer, required - `uid` string, required - `key_id` string, required - `fingerprint` string, required - `type` 'RSA' | 'ECC', required - `expires` string, date-time, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `role` Role - `id` string, uuid, required - `name` 'admin' | 'guest' | 'user', required - `description` string, required - `created` string, date-time, required - `modified` string, date-time, required - `missing_metadata_key_ids` string[] - `last_logged_in` string, date-time - `group` GroupIndexAndView - `id` string, uuid, required - `name` string, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `my_group_user` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView - … - `groups_users` GroupsUsersIndexAndView[] - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView - … - `user_count` integer - `permissions` PermissionIndexAndView[] - `id` string, uuid, required - `aco` 'Resource' | 'Folder', required - `aco_foreign_key` string, uuid, required - `aro` 'User' | 'Group', required - `aro_foreign_key` string, uuid, required - `type` 1 | 7 | 15, required: * `1` - Read * `7` - Update * `15` - Owner - `created` string, date-time, required - `modified` string, date-time, required - `user` UserIndexAndView - `is_mfa_enabled` boolean - `id` string, uuid, required - `role_id` string, uuid, required - `username` string, required - `active` boolean, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `disabled` string, date-time, required - `profile` object - `id` string, uuid, required - `user_id` string, uuid, required - `first_name` string, required - `last_name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `avatar` object, required - … - `groups_users` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView (recursive) - `gpgkey` Gpgkey - `id` string, uuid, required - `user_id` string, uuid, required - `armored_key` string, required - `bits` integer, required - `uid` string, required - `key_id` string, required - `fingerprint` string, required - `type` 'RSA' | 'ECC', required - `expires` string, date-time, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `role` Role - `id` string, uuid, required - `name` 'admin' | 'guest' | 'user', required - `description` string, required - `created` string, date-time, required - `modified` string, date-time, required - `missing_metadata_key_ids` string[] - `last_logged_in` string, date-time - `group` GroupIndexAndView - `id` string, uuid, required - `name` string, required - `deleted` boolean, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `my_group_user` GroupsUsersIndexAndView - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView - … - `groups_users` GroupsUsersIndexAndView[] - `id` string, uuid, required - `group_id` string, uuid, required - `user_id` string, uuid, required - `is_admin` boolean, required - `created` string, date-time, required - `user` UserIndexAndView - … - `user_count` integer - `children_resources` union[] - union - ResourceV4IndexAndView - `id` string, uuid, required - `name` string, required - `username` string, required - `uri` string, required - `description` string, required - `deleted` boolean, required - `created` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `resource_type_id` string, uuid, required - `expired` string, date-time, required - `folder_parent_id` string, uuid, required - `personal` boolean, required - `favorite` Favorite - … - `modifier` UserIndexAndView - … - `creator` UserIndexAndView - … - `secrets` SecretIndex[] - … - `resource_type` ResourceType - … - `permission` PermissionIndexAndView - … - `permissions` PermissionIndexAndView[] - … - ResourceV5IndexAndView - `metadata` string, required: An armoured OpenPGP message. Its cleartext is a JSON object carrying an `object_type` field that names the payload, `PASSBOLT_RESOURCE_METADATA` for a resource, and the descriptive fields that used to travel in clear in the v4 format. The fields expected for a resource, and the two decryption paths, are described in the guide on working with v5 encrypted metadata. - `metadata_key_id` string, uuid, required - `metadata_key_type` 'user_key' | 'shared_key', required - `id` string, uuid, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `personal` boolean, required - `folder_parent_id` string, uuid, required - `modifier` UserIndexAndView - … - `creator` UserIndexAndView - … - `permission` PermissionIndexAndView - … - `permissions` PermissionIndexAndView[] - … - `resource_type_id` string, uuid, required - `expired` string, date-time, required - `favorite` Favorite - … - `offline` OfflineItem: The mark that makes a resource available offline for one user. It is created when the user marks the item and holds no data of its own beyond the link. - … - `secrets` SecretIndex[] - … - `resource_type` ResourceType - … - `children_folders` union[] - union - FolderV4IndexAndView - `id` string, uuid, required - `name` string, required - `created` string, date-time, required - `modified` string, date-time, required - `created_by` string, uuid, required - `modified_by` string, uuid, required - `folder_parent_id` string, uuid, required - `personal` boolean, required - `modifier` UserIndexAndView - … - `creator` UserIndexAndView - … - `permission` PermissionIndexAndView - … - `permissions` PermissionIndexAndView[] - … - `children_resources` union[] - … - `children_folders` union[] - … - FolderV5IndexAndView (recursive) ## Other responses - `400`: Bad request - `401`: Authentication required. - `404`: Not found ## Changes - **2026-11-06** `8d72215e2274`: 3 breaking, 21 info - the `body/anyOf[#/components/schemas/folderV4IndexAndView]/children_folders/items/anyOf[#/components/schemas/folderV5IndexAndView]/allOf[subschema #2]/children_resources/items/anyOf[#/components/schemas/resourceV5IndexAndView]/allOf[subschema #2]/secrets/items/` response's property type changed from `string` to `object` for status `200` - the `body/anyOf[#/components/schemas/folderV4IndexAndView]/children_resources/items/anyOf[#/components/schemas/resourceV5IndexAndView]/allOf[subschema #2]/secrets/items/` response's property type changed from `string` to `object` for status `200` - the `body/anyOf[#/components/schemas/folderV5IndexAndView]/allOf[subschema #2]/children_resources/items/anyOf[#/components/schemas/resourceV5IndexAndView]/allOf[subschema #2]/secrets/items/` response's property type changed from `string` to `object` for status `200` - added the optional property `body/anyOf[#/components/schemas/folderV4IndexAndView]/children_folders/items/anyOf[#/components/schemas/folderV5IndexAndView]/allOf[subschema #2]/children_resources/items/anyOf[#/components/schemas/resourceV5IndexAndView]/allOf[subschema #2]/offline` to the response with the `200` status - …20 more - …earlier changes not shown [Operation history](https://skmtc.dev/passbolt/apis/passbolt-api/changes/folders/:folderId.json/get.md) --- [API](https://skmtc.dev/passbolt/apis/passbolt-api.md) - [All operations](https://skmtc.dev/passbolt/apis/passbolt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passbolt/apis/passbolt-api/revisions/8d72215e2274?raw)