Action logs4

Authentication (GPGAuth)5

Authentication (JWT)5

Avatars1

Comments4

Directory Sync2

Favorites2

Folders5

GPG keys2

Groups7

Healthcheck2

Metadata keys6

Metadata private keys2

Metadata rotate key6

Metadata session key4

Metadata types settings2

Metadata upgrade6

Move1

Multi-Factor Authentication3

Offline mode3

Permissions1

Resource types4

Resources5

Roles1

Secrets1

Settings1

Shares4

Tags3

Users6

Resources

Get a resource.

Changed on Nov 6, 2026

get/resources/{resourceId}.json

Request

Base URL
https://passbolt.local
Auth
HTTP bearer
TypeScript
https://skmtc.dev/passbolt/apis/passbolt-api/docs/resources/:resourceId.json/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

resourceIdstring uuid required

ID for the resource being manipulated.

Query parameters

contain[creator]1 | 0

Add creator to response body.

contain[favorite]1 | 0

Add favorite to response body.

contain[modifier]1 | 0

Add modifier to response body.

contain[secret]1 | 0

Add secrets to response body.

contain[resource-type]1 | 0

Add resource type to response body.

contain[permission]1 | 0

Add permission to response body.

contain[permissions]1 | 0

Add permissions to response body.

contain[permissions.user.profile]1 | 0

Add user profile to permissions in response body.

contain[permissions.group]1 | 0

Add group to permissions in response body.

Response

Operation is successful

Changes

Nov 6, 20268d72215e2274 Revision changes
- breaking
  the /////// response's property type changed from string to object for status
- info
  added the optional property ////// to the response with the status
- info
  added the required property //////// to the response with the status
- info
  added the required property //////// to the response with the status
- info
  added the required property //////// to the response with the status
- info
  added the required property //////// to the response with the status
- info
  added the required property //////// to the response with the status
- info
  added the required property //////// to the response with the status
Jun 25, 2025829cf48ab700 Revision changes
- breaking
  the response's property type changed from object to no type for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added to the response property anyOf list for the response status

Operation history