List connectors. GET /api/openapi/v1/connectors, scope admin.v1.connectors.read.
- Scope: admin.v1.connectors.read
- Permission: Read connectors (connectors)
- Permission type: Read
- Endpoint: GET/api/openapi/v1/connectors
Authentication and request headers
Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| Authorization | header | string | Yes | Application API key, passed as a Bearer token. | Bearer qwk_*** |
| X-Request-Id | header | string | No | Optional request tracing identifier; generated by the server if omitted. | req-20260831-001 |
Request parameters
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| keyword | query | string | No | Search keyword | "<string>" |
| status | query | string | No | Enabled | "draft" |
| origin | query | string | No | Origin | "all" |
| category_id | query | string · uuid | No | Category (category ID) | "<uuid>" |
| page | query | integer · int64 | No | Page number | 1 |
| page_size | query | integer · int64 | No | Page size | 20 |
Request example
cURL
Responses
200 OK
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| items | array ｜ null | Yes | Connectors | [{"api_key":{"header_name":"<string>","value_prefix":"<string>"},"auth_type":"<string>","clients":["<string>"],"command":"<string>","created_at":"2026-08-27T10:00:00Z","created_by":"<string>","created_by_email":"<string>","created_by_name":"<string>","description":"<string>","description_cn":"<string>","display_name":"<string>","display_name_cn":"<string>","icon_url":"<string>","id":"<string>","oauth_client_registration":"<string>","oauth_scopes":"<string>","origin":"<string>","revision":0,"server_key":"<string>","source_type":"official","status":"<string>","transport":"<string>","updated_at":"2026-08-27T10:00:00Z","updated_by":"<string>","updated_by_email":"<string>","updated_by_name":"<string>","url":"<string>","version":"<string>"}] |
| next_cursor | string | No | Next page cursor | "<string>" |
| page | integer · int64 | Yes | Page number | 0 |
| page_size | integer · int64 | Yes | Page size | 0 |
| total_pages | integer · int64 | Yes | Total pages | 0 |
| total_rows | integer · int64 | Yes | Total count | 0 |
default Flat business error
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| code | string | No | Stable business error code | "<string>" |
| detail | string | Yes | Human-readable error description | "<string>" |
| details | OpenapiErrorDetails | No | Error details | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | No | Request field that failed validation | "<string>" |
| details.reason | string | No | Stable validation failure reason | "<string>" |
| details.suggestion | string | No | Suggested normalized value | "<string>" |
| error | string | Yes | Stable HTTP error type | "<string>" |