> ## Documentation Index > Fetch the complete documentation index at: https://docs.checkfu.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Base URL: https://api.checkfu.com. Current wire version: `2026-08-31` (`Checkfu-Version: 2026-08-31`). > Mutating HTTP requests require `Authorization: Bearer $CHECKFU_API_KEY`, `Checkfu-Version: 2026-08-31`, `Content-Type: application/json`, and `Idempotency-Key` on retriable writes. Ordinary API keys are Workspace-bound; do not send a Workspace selector header. > Core workflow: create an Agent (`POST /v1/agents`) and Environment (`POST /v1/environments`), grant `use_environment` (`POST /v1/permission-assignments`), create a Session (`POST /v1/sessions`), send events (`POST /v1/sessions/{id}/events`), stream progress (`GET /v1/sessions/{id}/events/stream`), and read the input result (`GET /v1/sessions/{id}/inputs/{input_id}/result`). > Domain model: an Agent is mutable configuration; a Session freezes its AgentVersion and Environment at creation and owns its private workspace and ordered event history. Vault stores secret credentials; Connection links an external account; ActionApproval records human approval before an action runs. > Capability status combines `audience`, `stability`, `availability`, evaluated prerequisites, and release evidence; check https://docs.checkfu.com/getting-started/status (`GET /v1/support/capabilities`) for live `available` status. # List what uses a Connection > Read the automations that use this Connection, limited to those the caller may view. ## OpenAPI ````yaml /openapi.json get /v1/connections/{id}/uses openapi: 3.1.0 info: title: Checkfu API version: '2026-08-31' description: >- Authentication is declared per operation: API-key, runtime, or connector bearer; Automation signature; or credential-free pairing redemption. Every general Checkfu REST request requires the dated `Checkfu-Version` header (one of: 2026-08-31); the three MCP JSON-RPC transports use `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth callback carries neither Checkfu header. API keys resolve one Workspace without a request selector; authenticated responses identify it with `Checkfu-Workspace-Id`. servers: - url: https://api.checkfu.com security: - bearerAuth: [] tags: - name: organizations - name: sourceRepositories - name: tenants - name: workspaces - name: principals - name: principalGroups - name: principalAccessCredentials - name: apiKeys - name: agents - name: harnessRuntime - name: permissionAssignments - name: actionPolicies - name: files - name: memoryStores - name: modelCredentials - name: modelRoutingProfiles - name: toolSources - name: skills - name: skillSources - name: skillProposals - name: instructionProposals - name: catalog - name: concepts - name: support - name: connections - name: connectionAssignments - name: connectedRuntimes - name: fileTrees - name: collaboration - name: automationGraphs - name: automations - name: actionApprovals - name: standingApprovals - name: workloadReviewPolicies - name: usage - name: models - name: budgets - name: billing - name: sessions - name: audit - name: sessionExports - name: runs - name: runnerPools - name: transcripts - name: sessionWatches - name: sessionCapsules - name: sessionTrajectories - name: webhookEndpoints - name: integrationGateway - name: environments - name: vaults - name: apiMcp - name: a2a paths: /v1/connections/{id}/uses: get: tags: - connections summary: List what uses a Connection description: >- Read the automations that use this Connection, limited to those the caller may view. Each carries the trigger registrations made under the account (provider webhooks and MCP event subscriptions, with status and whether the signing secret was minted by Checkfu or issued by the provider) and the steps that call its tools. It never returns a secret value, credential or custody handle. Checkfu support posture: alpha; hosted. Required evidence journey: connection-lifecycle. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. operationId: connections.getConnectionUses parameters: - name: id in: path schema: $ref: '#/components/schemas/ConnectionId' required: true - name: checkfu-version in: header schema: type: string enum: - '2026-08-31' required: true responses: '200': description: >- The automations the caller may view that use this Connection, with their trigger registrations (status and whether each holds a signing secret, never its value) and tool calls. content: application/json: schema: $ref: '#/components/schemas/ConnectionUses' headers: checkfu-workspace-id: description: The Workspace resolved from the authenticated bearer credential. required: true schema: $ref: '#/components/schemas/WorkspaceId' '400': description: Typed Checkfu wire error content: application/json: schema: type: object properties: type: type: string enum: - error error: type: object properties: type: type: string enum: - invalid_request_error code: type: string enum: - validation.malformed message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#validation-malformed description: >- Stable public documentation and remedy for this error type. required: - type - code - message - more additionalProperties: false request_id: type: string minLength: 1 required: - type - error - request_id additionalProperties: false '401': description: Typed Checkfu wire error content: application/json: schema: type: object properties: type: type: string enum: - error error: type: object properties: type: type: string enum: - authentication_error code: type: string enum: - auth.invalid_key message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-invalid-key description: >- Stable public documentation and remedy for this error type. required: - type - code - message - more additionalProperties: false request_id: type: string minLength: 1 required: - type - error - request_id additionalProperties: false '403': description: >- The organization, tenant, or workspace backing this key is administratively disabled. | Deployment governance or retention policy denied the request. content: application/json: schema: anyOf: - type: object properties: type: type: string enum: - error error: type: object properties: type: type: string enum: - permission_error code: type: string enum: - auth.disabled_tenancy message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-disabled-tenancy description: >- Stable public documentation and remedy for this error type. required: - type - code - message - more additionalProperties: false request_id: type: string minLength: 1 required: - type - error - request_id additionalProperties: false - $ref: '#/components/schemas/PolicyDeniedError' '404': description: >- The requested resource does not exist in the resolved deployment boundary. content: application/json: schema: $ref: '#/components/schemas/ValidationNotFoundError' '409': description: The request conflicts with the resource's current state. content: application/json: schema: $ref: '#/components/schemas/ValidationConflictError' '429': description: Typed Checkfu wire error headers: retry-after: description: >- Delay in seconds for rate limits or deployment quotas with a known release or UTC reset boundary required: false schema: type: integer minimum: 1 content: application/json: schema: type: object properties: type: type: string enum: - error error: type: object properties: type: type: string enum: - rate_limit_error code: type: string enum: - budget.exceeded message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#budget-exceeded description: >- Stable public documentation and remedy for this error type. required: - type - code - message - more additionalProperties: false request_id: type: string minLength: 1 required: - type - error - request_id additionalProperties: false '500': description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. content: application/json: schema: $ref: '#/components/schemas/RuntimeInternalError' security: - bearerAuth: [] components: schemas: ConnectionId: type: string pattern: ^conn_[0-9a-f]{32}$ ConnectionUses: type: object properties: connection_id: $ref: '#/components/schemas/ConnectionId' automations: type: array items: $ref: '#/components/schemas/ConnectionAutomationUse' maxItems: 10000 grant_audiences: type: array items: $ref: '#/components/schemas/ConnectionGrantAudience' maxItems: 32 required: - connection_id - automations additionalProperties: false description: >- The automations the caller may view that use this Connection, with their trigger registrations (status and whether each holds a signing secret, never its value) and tool calls. WorkspaceId: type: string pattern: ^wrkspc_[0-9a-f]{32}$ PolicyDeniedError: type: object properties: error: type: object properties: type: type: string enum: - permission_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#policy-denied description: Stable public documentation and remedy for this error type. code: type: string enum: - policy.denied required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: Deployment governance or retention policy denied the request. ValidationNotFoundError: type: object properties: error: type: object properties: type: type: string enum: - not_found_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-not-found description: Stable public documentation and remedy for this error type. code: type: string enum: - validation.not_found required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: >- The requested resource does not exist in the resolved deployment boundary. ValidationConflictError: type: object properties: error: type: object properties: type: type: string enum: - conflict_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-conflict description: Stable public documentation and remedy for this error type. code: type: string enum: - validation.conflict required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: The request conflicts with the resource's current state. RuntimeInternalError: type: object properties: error: type: object properties: type: type: string enum: - api_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#runtime-internal description: Stable public documentation and remedy for this error type. code: type: string enum: - runtime.internal required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. ConnectionAutomationUse: type: object properties: automation_id: $ref: '#/components/schemas/AutomationId' name: type: string triggers: type: array items: $ref: '#/components/schemas/ConnectionTriggerUse' maxItems: 1000 tool_uses: type: array items: $ref: '#/components/schemas/ConnectionToolUse' maxItems: 1000 required: - automation_id - name - triggers - tool_uses additionalProperties: false ConnectionGrantAudience: type: object properties: audience: type: string maxLength: 2048 declared_by: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ required: - audience - declared_by additionalProperties: false AutomationId: type: string pattern: ^auto_[0-9a-f]{32}$ ConnectionTriggerUse: anyOf: - type: object properties: kind: type: string enum: - provider_webhook registration_id: $ref: '#/components/schemas/ProviderWebhookRegistrationId' webhook_source_id: $ref: '#/components/schemas/WebhookSourceId' status: $ref: '#/components/schemas/ProviderWebhookRegistrationStatus' event_types: type: array items: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ maxItems: 100 has_signing_secret: type: boolean required: - kind - registration_id - webhook_source_id - status - event_types - has_signing_secret additionalProperties: false - type: object properties: kind: type: string enum: - mcp_event subscription_id: $ref: '#/components/schemas/McpEventSubscriptionId' webhook_source_id: $ref: '#/components/schemas/WebhookSourceId' status: $ref: '#/components/schemas/McpEventSubscriptionStatus' event_name: $ref: '#/components/schemas/McpEventName' has_signing_secret: type: boolean required: - kind - subscription_id - webhook_source_id - status - event_name - has_signing_secret additionalProperties: false ConnectionToolUse: type: object properties: step_id: type: string maxLength: 256 tool: type: string maxLength: 256 required: - step_id - tool additionalProperties: false ProviderWebhookRegistrationId: type: string pattern: ^pwreg_[0-9a-f]{32}$ WebhookSourceId: type: string pattern: ^whsrc_[0-9a-f]{32}$ ProviderWebhookRegistrationStatus: type: string enum: - pending - active - degraded - disabled - indeterminate - revoked - deleted McpEventSubscriptionId: type: string pattern: ^mevsub_[0-9a-f]{32}$ McpEventSubscriptionStatus: type: string enum: - pending - active - degraded - expired - revoked - failed - deleting - deleted McpEventName: type: string minLength: 1 maxLength: 256 description: The exact upstream MCP event name, compared byte for byte. securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.