---
title: "List OAuth configurations"
method: GET
path: "/oauth"
tags: ["OAuth Configuration"]
---

# List OAuth configurations

`GET /oauth`

## Request

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

List the saved OAuth apps of every connector type in the organization.<br><br>
Every caller, admin or not, gets the same essential fields (ID, name, connector type, app
metadata, timestamps). Credentials are never included; an admin reads them per app with
<code>GET /oauth/{connectorType}/{configId}</code>.

## Query parameters

- `page` integer
- `limit` integer
- `search` string

## Response `200`

OAuth apps of every connector type

- object
  - `success` boolean, required
  - `oauthConfigs` OAuthConfig[], required
    - `_id` string, uuid: OAuth app ID: the `oauthConfigId` to link a connector to
    - `oauthInstanceName` string
    - `connectorType` string
    - `iconPath` string: Icon of the connector type, copied from the OAuth registry when the configuration was created
    - `appGroup` string: Application group of the connector type (empty when the type is not in the OAuth registry)
    - `appDescription` string: Description of the connector type's OAuth application
    - `appCategories` string[]: Categories of the connector type
    - `config` object: OAuth app credentials; keys follow the connector type's OAuth fields
      - `clientId` string
      - `clientSecret` string
    - `userId` string
    - `updatedBy` string
    - `createdAtTimestamp` integer: Epoch milliseconds
    - `updatedAtTimestamp` integer: Epoch milliseconds
    - `authorizeUrl` string
    - `tokenUrl` string
    - `redirectUri` string
    - `scopes` object: Provider scopes requested per use
  - `pagination` OAuthConfigPagination, required
    - `page` integer, required
    - `limit` integer, required
    - `search` string, nullable
    - `totalItems` integer, required
    - `totalPages` integer, required
    - `hasPrev` boolean, required
    - `hasNext` boolean, required

## 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
- `500`: The configurations could not be loaded. 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`: 2 warning, 1 info
  - removed the optional property `oauthConfigs/items/createdBy` from the response with the `200` status
  - removed the optional property `oauthConfigs/items/orgId` from the response with the `200` status
  - added the non-success response with the status `500`
- **2026-10-15** `a44792e4f0e6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api/changes/oauth/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)