--- title: "Connections and OAuth applications" description: "Context4 service connections and OAuth configurations: manage connected accounts and provider schemas through the API." group: "Technical documentation" order: 32 --- ## Deployment addresses - Documentation: https://ctx4.me/docs.md - Agent index: https://ctx4.me/docs/agent-index.json - Console and connections: https://console.ctx4.me/integrations - MCP: https://ctx4.me/mcp - HTTP API: https://ctx4.me/v1 - Composio base URL: https://ctx4.me/compat/context4/v1 - OpenAPI: https://ctx4.me/docs/openapi.json - HTTP/MCP inventory: https://ctx4.me/docs/api-index.json - Composio routes: https://ctx4.me/docs/compat-routes.json - Connectors: https://ctx4.me/docs/connectors.json # Connections and OAuth applications Generated from the public Context4 OpenAPI. Authenticate with `Authorization: Bearer` and an API key. General rules: [API](https://ctx4.me/docs/api.md). Full contract: [OpenAPI JSON](https://ctx4.me/docs/openapi.json). In the JSON below, `$ref` points to a named schema in the Schemas section. ## listConnections `GET /v1/connections` Deployment URL: `https://ctx4.me/v1/connections`. Replace parameters in braces with actual IDs from the API. List connections Capability: `connections:read`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `status` | query | no | {"type":"string","enum":["pending","active","degraded","revoked","failed"]} | | `user_id` | query | no | {"$ref":"#/components/schemas/EndUserRef"} | | `cursor` | query | no | {"type":"string","minLength":1,"maxLength":400,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque pagination cursor from a previous response"} Opaque pagination cursor from a previous response | | `limit` | query | no | {"type":"integer","minimum":1,"maximum":100,"description":"Page size (1-100, default 20)"} Page size (1-100, default 20) | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Connections in the key's workspace | `application/json` [ConnectionListResponse](https://ctx4.me/docs/api-schemas-1.md#connectionlistresponse) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## createConnection `POST /v1/connections` Deployment URL: `https://ctx4.me/v1/connections`. Replace parameters in braces with actual IDs from the API. Initiate a connection (hosted auth link) Capability: `connections:write`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `Idempotency-Key` | header | yes | {"type":"string"} Client-chosen key (8-128 chars of [A-Za-z0-9._:-]); replays with the same payload return the original outcome | ### Request body Required. [CreateConnectionRequest](https://ctx4.me/docs/api-schemas-2.md#createconnectionrequest) ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectionRequest" } } } } ``` ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 201 | Hosted authorization link for the end user | `application/json` [HostedAuthLink](https://ctx4.me/docs/api-schemas-2.md#hostedauthlink) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing, forbidden) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 409 | Problem (conflict) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## getConnection `GET /v1/connections/{connectionId}` Deployment URL: `https://ctx4.me/v1/connections/{connectionId}`. Replace parameters in braces with actual IDs from the API. Get one connection Capability: `connections:read`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `connectionId` | path | yes | {"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"} | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Connection view (engine-free) | `application/json` [Connection](https://ctx4.me/docs/api-schemas-1.md#connection) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## listAuthConfigs `GET /v1/auth-configs` Deployment URL: `https://ctx4.me/v1/auth-configs`. Replace parameters in braces with actual IDs from the API. List auth configurations Capability: `connections:read`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `connector_id` | query | no | {"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,78}$","example":"bitrix24"} | | `cursor` | query | no | {"type":"string","minLength":1,"maxLength":400,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque pagination cursor from a previous response"} Opaque pagination cursor from a previous response | | `limit` | query | no | {"type":"integer","minimum":1,"maximum":100,"description":"Page size (1-100, default 20)"} Page size (1-100, default 20) | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Auth configurations in the key's workspace | `application/json` [AuthConfigListResponse](https://ctx4.me/docs/api-schemas-2.md#authconfiglistresponse) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## createAuthConfig `POST /v1/auth-configs` Deployment URL: `https://ctx4.me/v1/auth-configs`. Replace parameters in braces with actual IDs from the API. Create an auth configuration Capability: `connections:write`. The contract defines no additional parameters. ### Request body Required. [CreateAuthConfigRequest](https://ctx4.me/docs/api-schemas-2.md#createauthconfigrequest) ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAuthConfigRequest" } } } } ``` ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 201 | The created auth configuration | `application/json` [AuthConfig](https://ctx4.me/docs/api-schemas-2.md#authconfig) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing, forbidden) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 409 | Problem (conflict) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## getAuthConfig `GET /v1/auth-configs/{authConfigId}` Deployment URL: `https://ctx4.me/v1/auth-configs/{authConfigId}`. Replace parameters in braces with actual IDs from the API. Get one auth configuration Capability: `connections:read`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `authConfigId` | path | yes | {"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"} | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Auth configuration (secret-free) | `application/json` [AuthConfig](https://ctx4.me/docs/api-schemas-2.md#authconfig) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## updateAuthConfig `PATCH /v1/auth-configs/{authConfigId}` Deployment URL: `https://ctx4.me/v1/auth-configs/{authConfigId}`. Replace parameters in braces with actual IDs from the API. Update an auth configuration Capability: `connections:write`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `authConfigId` | path | yes | {"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"} | ### Request body Required. [UpdateAuthConfigRequest](https://ctx4.me/docs/api-schemas-2.md#updateauthconfigrequest) ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAuthConfigRequest" } } } } ``` ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | The updated auth configuration | `application/json` [AuthConfig](https://ctx4.me/docs/api-schemas-2.md#authconfig) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing, forbidden) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 409 | Problem (conflict) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## deleteAuthConfig `DELETE /v1/auth-configs/{authConfigId}` Deployment URL: `https://ctx4.me/v1/auth-configs/{authConfigId}`. Replace parameters in braces with actual IDs from the API. Delete an auth configuration Capability: `connections:write`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `authConfigId` | path | yes | {"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"} | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 204 | Deleted | The contract does not define a body | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing, forbidden) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 409 | Problem (conflict) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## getProviderSchema `GET /v1/connections/{connectionId}/schemas/{entity}` Deployment URL: `https://ctx4.me/v1/connections/{connectionId}/schemas/{entity}`. Replace parameters in braces with actual IDs from the API. Read the latest discovered provider entity schema Capability: `connections:read`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `connectionId` | path | yes | {"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"} | | `entity` | path | yes | {"type":"string","minLength":1,"maxLength":80} | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Latest tenant-scoped provider schema | `application/json` [ProviderSchema](https://ctx4.me/docs/api-schemas-3.md#providerschema) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing, forbidden) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## discoverProviderSchema `POST /v1/connections/{connectionId}/schemas/{entity}` Deployment URL: `https://ctx4.me/v1/connections/{connectionId}/schemas/{entity}`. Replace parameters in braces with actual IDs from the API. Discover and persist provider entity metadata Capability: `connections:write`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `Idempotency-Key` | header | yes | {"type":"string"} Client-chosen key (8-128 chars of [A-Za-z0-9._:-]); replays with the same payload return the original outcome | | `connectionId` | path | yes | {"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"} | | `entity` | path | yes | {"type":"string","minLength":1,"maxLength":80} | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Immutable provider schema revision | `application/json` [ProviderSchema](https://ctx4.me/docs/api-schemas-3.md#providerschema) | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing, forbidden) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ```