List collections shared with mailbox
Returns calendar and addressbook collections shared with the mailbox by other users.
bearerAuthAuthorizationBearer <token>Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.
oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.
oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.
Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].
identityId*stringIdentity ULID identifier
List of shared collections
application/json- response
shared*array<>curl -X GET 'https://api.open.email/api/v1/identities/string/pim/shared-with-me'{
"shared": [
{
"collectionId": "string",
"color": "string",
"components": [
"VEVENT"
],
"createdAt": 0,
"description": "string",
"descriptionLang": "string",
"displayName": "string",
"kind": "calendar",
"name": "string",
"objectCount": 0,
"ownerAddress": "string",
"ownerIdentityId": "string",
"permission": "read",
"scheduleTransp": "opaque",
"syncToken": "string",
"taskCounts": {
"active": 0,
"closed": 0
}
}
]
}