---
title: "List available connector types"
method: GET
path: "/connectors/registry"
tags: ["Connector Registry"]
---

# List available connector types

`GET /connectors/registry`

## Request

- Base URL: `https://app.pipeshub.com/api/v1`
- URL: `https://app.pipeshub.com/api/v1/connectors/registry`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `/api/v1/oauth2/authorize`
    - Client credentials
    - Token URL: `/api/v1/oauth2/token` scopes: `connector:read`

Get all available connector types from the registry.<br><br>
<b>Overview:</b><br>
The registry contains all connector types that can be configured as instances.
Each type has specific authentication requirements, supported scopes, and capabilities.<br><br>
<b>Connector Types Include:</b><br>
<ul>
<li><b>Google Workspace:</b> Drive, Gmail, Calendar, etc.</li>
<li><b>Microsoft 365:</b> OneDrive, Outlook, SharePoint, etc.</li>
<li><b>Cloud Storage:</b> Dropbox, Box, AWS S3</li>
<li><b>Collaboration:</b> Slack, Confluence, Notion, Jira</li>
<li><b>Databases:</b> PostgreSQL, MySQL, MongoDB</li>
</ul>
<b>Filtering:</b><br>
Use <code>scope</code> to filter by team or personal connectors.
Use <code>search</code> for full-text search across connector names.

## Query parameters

- `scope` 'team' | 'personal': Scope determines visibility and access control for connectors:<br> <ul> <li><code>team</code> - Available to all users in the organization (admin-only creation)</li> <li><code>personal</code> - Private to the creating user only</li> </ul>
- `page` integer
- `limit` integer
- `search` string
- `isAuthenticated` boolean
- `isActive` boolean
- `connectorType` string

## Response `200`

Connector registry retrieved

- object
  - `success` boolean, required
  - `connectors` ConnectorRegistryEntry[], required
    - `name` string: Display name
    - `type` string: Connector type: the value to pass as `connectorType`
    - `appGroup` string: Product family the connector belongs to
    - `supportedAuthTypes` ConnectorAuthType[]: Authentication methods an instance of this type can be created with
    - `appDescription` string: One-line description of what the connector syncs
    - `appCategories` string[]: Categories the connector is listed under
    - `iconPath` string: Path of the connector icon
    - `supportsRealtime` boolean: Whether the connector can receive real-time updates
    - `supportsSync` boolean: Whether the connector syncs data into the knowledge base
    - `supportsAgent` boolean: Whether the connector can be used by AI agents
    - `documentationLinks` ConnectorDocumentationLink[]
      - `title` string: Link text
      - `url` string: Link target
      - `type` string: Free-form link category set by the connector, for example `setup`, `pipeshub`, `api` or `docs`.
    - `isAdminAccessRequired` boolean: Whether setting the connector up needs admin rights in the source system
    - `personalConnectorType` string, nullable: For a team connector type, its personal counterpart, if any
    - `connectorInfo` string, nullable: Guidance shown before setup
    - `scope` 'team' | 'personal': Scope determines visibility and access control for connectors:<br> <ul> <li><code>team</code> - Available to all users in the organization (admin-only creation)</li> <li><code>personal</code> - Private to the creating user only</li> </ul>
  - `pagination` ConnectorPagination, required
    - `page` integer, required
    - `limit` integer, required
    - `search` string, nullable: The search term the list was filtered by
    - `totalCount` integer, required: Number of items matching the request across all pages
    - `totalPages` integer, required: Number of pages at the current `limit`
    - `hasPrev` boolean, required: Whether a page exists before this one
    - `hasNext` boolean, required: Whether a page exists after this one
    - `prevPage` integer, nullable: Previous page number, `null` on the first page
    - `nextPage` integer, nullable: Next page number, `null` on the last page
  - `registryCountsByScope` object: How many connector types each scope offers
    - `team` integer
    - `personal` integer

## Other responses

- `400`: Invalid request: a parameter or the body failed validation Also returned, before authentication, when a query value, or any string in a JSON or form-encoded body, looks like markup to the app-wide XSS filter: an HTML tag, a script tag, `<iframe`, `<object`, `<embed` or `<svg` tag, a word starting with `on` followed by `=` (meant for inline event handlers such as `onerror=`, it also catches plain text such as `one=1`), a `javascript:` or `data:text/html` URL, an encoded script tag (`&lt;script`, `%3cscript`), or any string longer than 100,000 characters (`HTTP_BAD_REQUEST`, "HTML tags, scripts, and XSS content are not allowed in ...", naming the field or query parameter; a string over 100,000 characters is refused as too long instead). A JSON body that does not parse is refused the same way, also before authentication (`HTTP_BAD_REQUEST`, "The request body is not valid JSON.").
- `401`: Missing or invalid credentials
- `403`: The token lacks a required scope, or the caller may not use this connector
- `404`: The registry has no connector types
- `500`: Internal server error. A JSON body larger than 10 MB, or a form-encoded body larger than 100 KB or with more than 1000 fields, is answered `413` by the app-wide body parsers instead, also before authentication.

## Changes

- **2026-10-28** `dbb5e203b445`: 4 info
  - added the new optional `query` request parameter `connectorType`
  - added the new optional `query` request parameter `isActive`
  - added the new optional `query` request parameter `isAuthenticated`
  - added the non-success response with the status `500`
- **2026-10-26** `fc76aa045994`: 2 warning
  - added the new `ENTRA_ID` enum value to the `connectors/items/supportedAuthTypes/items/` response property for the response status `200`
  - added the new `IAM_ROLE` enum value to the `connectors/items/supportedAuthTypes/items/` response property for the response status `200`
- **2026-10-15** `a44792e4f0e6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api/changes/connectors/registry/get.md)

---

[API](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api.md) - [All operations](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api/revisions/dbb5e203b445?raw)