Read a provider resource by reference
Fetches the content of a provider resource identified by an external reference rather than a linked resource id, so a browsed item can be previewed before it is linked or imported. Requires both the `resources:read` and `integrations:read` workspace permissions, checked live before any cached copy is served, and is subject to the same short-lived content mirror as reading a linked resource.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/integrations/resources/read" \ -H "Content-Type: application/json" \ -d '{ "connectionId": "string", "resource": { "externalType": "string", "externalId": "string", "name": "string", "surfaceKind": "generic", "capabilities": [ "browse" ] } }'{ "data": { "format": "json", "content": null, "revision": "string", "readOnly": true, "fallbackUrl": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Read the content of a linked external resource
Fetches a linked resource's current content from its provider and returns it in the format the provider exposes, along with its revision, whether it is read-only, and a fallback URL when Snoze cannot render it. Requires the `resources:read` workspace permission, which is re-checked on every request before any cached copy is served. Content is served from a short-lived encrypted mirror, so a response may be up to a few minutes stale while it refreshes.
Read the resource behind a placement
Returns the placement together with the external resource it points at, which is how a workspace item resolves back to its provider origin. Requires both the `resources:read` and `integrations:read` workspace permissions; an unknown placement is reported as not found.