---
title: "List providers"
method: GET
path: "/v4/organizations/{organizationId}/aiServices/providers"
tags: ["AI Data Plane Providers"]
---

# List providers

`GET /v4/organizations/{organizationId}/aiServices/providers`

Lists all the Provider integrations configured a given organization. Use the `providerType` to filter on the type of Provider.

In order to access this endpoint, the provided API key must have at least one of the following roles:
- Organization Owner

To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html).

## Query parameters

- `page` integer
- `perPage` integer
- `providerType` 'awsS3' | 'openAI' | 'awsBedrock'

## Response `200`

Successfully listed all the providers under the organization.

- ListProvidersResponse
  - `data` object[]
    - `id` string — The ID of the provider.
    - `name` string — The name of the provider.
    - `type` string — The type of the provider.
    - `configuration` union — The credentials for the provider.
      - object
        - `awsRegion` string — The AWS region the S3 bucket is located in.
        - `bucket` string — The name of the S3 bucket.
        - `folderPath` string — The path to the folder in the S3 bucket where the files are stored. Empty denotes the root folder.
      - object
    - `audit` CouchbaseAuditData
      - `createdBy` string, required — The user who created the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users.
      - `createdAt` string, date-time, required — The RFC3339 timestamp associated with when the resource was initially created.
      - `modifiedBy` string, required — The user who last modified the resource; this will be a UUID4 ID for standard users and wilmal be a string such as "internal-support" for internal Couchbase support users.
      - `modifiedAt` string, date-time, required — The RFC3339 timestamp associated with when the resource was last modified.
      - `version` integer, required — The version of the document. This value is incremented each time the resource is modified.
  - `cursor` Cursor
    - `pages` Pages, required
      - `page` integer, required — Current page of results, starting from page 1.
      - `next` integer — Number of the next page of results. Not set on the last page.
      - `previous` integer — Number of the previous page of results. Not set on the first page.
      - `last` integer, required — Number of the last page of results.
      - `perPage` integer, required — Number of items displayed in each page.
      - `totalItems` integer, required — Total items found by the given query.
    - `hrefs` Hrefs, required
      - `first` string, uri, required — The base URL, endpoint, and path parameters required to fetch the first page of results.
      - `last` string, uri, required — The base URL, endpoint, and path parameters required to fetch the last page of results.
      - `previous` string, uri, required — The base URL, endpoint, and path parameters required to fetch the previous page of results. Empty if there is no previous page.
      - `next` string, uri, required — The base URL, endpoint, and path parameters required to fetch the next page of results. Empty if there is no next page.

## Other responses

- `400` — Returned when we are unable to decode the recevied payload.
- `403` — The client does not have the necessary permissions to access this resource.
- `404` — The requested resource was not found.
- `429` — Returned when the client exceeds the rate limit for the given APIKey.
- `500` — An unexpected error occurred in the server while processing this request.

---

[API](https://skmtc.net/couchbase/apis/couchbase-capella-management-api.md) · [All operations](https://skmtc.net/couchbase/apis/couchbase-capella-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/couchbase/couchbase-capella-management-api/revisions/e67df5d1f74e/schema)