SnozeDevelopers
API referenceIntegrations

Browse the remote resources of a connection

Lists one level of a provider's resource tree through the connection, optionally under `parentExternalId`, filtered by `externalType`, or matched against `query`. Requires the `integrations:read` workspace permission and the provider feature enabled for the workspace; a provider whose adapter cannot browse is rejected as invalid. Paginated: pass `limit` (capped at 100) and the `cursor` from the previous response. Results are served from a short-lived encrypted mirror, so a listing may be up to a few minutes stale while it refreshes.

POST
/v1/workspaces/{workspaceId}/integrations/resources/browse
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string

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/browse" \  -H "Content-Type: application/json" \  -d '{    "connectionId": "string"  }'
{  "data": {    "resources": [      {        "externalType": "string",        "externalId": "string",        "name": "string",        "surfaceKind": "generic",        "capabilities": [          "browse"        ],        "mimeType": "string",        "canonicalUrl": "string",        "parentExternalId": "string",        "revision": "string",        "providerCreatedAt": "string",        "providerModifiedAt": "string",        "metadata": {}      }    ],    "cursor": "string"  }}