Open Connector
Resource API

Resource API

Read qualified resource identities and complete consistent inventory snapshots under the active connection scope.

Resource keys identify a source across products, organizations, and installations. Preserve the key returned by Connector instead of joining records by display name.

Use the shared request contract for authentication, pagination, preconditions, idempotency, and common errors. Exact response members are defined in API data types and the downloadable OpenAPI contract.

List shared resources

GET/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/resources
Scope
resources:read
Auth
Bearer API key

Lists the inventory and permitted summaries visible through active grants.

The first request fixes a snapshot. Subsequent pages retain its snapshot ID and grant generation. Cursors expire after 600 seconds (410 cursor_expired); a scope change returns 409 scope_changed. Restart from the first page and commit only a complete result. Inventory does not establish active protection.

Query parameters
limitintegeroptional

Number of records; bounds are inclusive.

default50rule1–200
cursorstringoptional

Opaque continuation; preserve the original filters.

200Result

Returns Resource records with snapshot_id, grant_revision, pagination, and request correlation.

Read a shared resource

GET/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/resources/{resource_key}
Scope
resources:read
Auth
Bearer API key

Returns the permitted present summary of a qualified source resource.

Percent-encode the opaque resource key as one path segment. Removed or no-longer-visible resources return 404 resource_not_found; use source history or removal events to investigate.

200Result

Returns data as Resource, plus request_id.