---
title: "List AppServices"
method: GET
path: "/v4/organizations/{organizationId}/appservices"
tags: ["App Services"]
---

# List AppServices

`GET /v4/organizations/{organizationId}/appservices`

## Request

- Base URL: `https://cloudapi.cloud.couchbase.com`
- URL: `https://cloudapi.cloud.couchbase.com/v4/organizations/{organizationId}/appservices`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/docs/v4/organizations/:organizationId/appservices/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists all the clusters under the organization.

In order to access this endpoint, the provided API key must have at least one of the roles referenced below:
- Organization Owner
- Project Owner
- Project Manager
- Project Viewer
- Database Data Reader/Writer
- Database Data Reader

Returned set of clusters is reduced to what the caller has access to view.
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
- `sortBy` string[]
- `sortDirection` 'asc' | 'desc'
- `projectId` string, uuid

## Response `200`

Successfully listed appservices matching query.

- GetAppServicesResponse
  - `data` GetAppServiceResponse[], required
    - `id` string, uuid, required: The ID of the App Service created.
    - `name` string, required: Name of the App Service (up to 256 characters).
    - `description` string, required: Description of the App Service (up to 1024 characters).
    - `cloudProvider` string, required: Provider is the cloud service provider for the App Service.
    - `nodes` integer, required: Number of nodes configured for the App Service.
    - `compute` AppServiceCompute, required: The CPU and RAM configuration of the App Service. The supported combinations are: | CPU (cores)| RAM (GB) | | -------- | ------- | | 2 | 4 | | 4 | 8 | | 8 | 16 | | 16 | 32 | | 36 | 72 |
      - `cpu` integer, required: CPU units (cores).
      - `ram` integer, required: RAM units (GB).
    - `clusterId` string, uuid, required: The ID of the cluster linked to the App Service.
    - `currentState` 'pending' | 'deploying' | 'deploymentFailed' | 'destroying' | 'destroyFailed' | 'healthy' | 'degraded' | 'scaling' | 'scaleFailed' | 'upgrading' | 'upgradeFailed' | 'turnedOff' | 'turningOff' | 'turnOffFailed' | 'turningOn' | 'turnOnFailed', required
    - `version` string, required: The version of the App Service server. If left empty, it will be defaulted to the latest available version.
    - `plan` 'basic' | 'developer pro' | 'enterprise', required: Plan type, either 'Basic', 'Developer Pro', or 'Enterprise'. Plan type allowed for singleNode cluster is either 'Basic', or 'Developer Pro'. In case of 'Basic' plan timezone field value is ignored.
    - `audit` CouchbaseAuditData, required
      - `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 will 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.
    - `loadBalancerCidr` string: The CIDR block reserved for the App Service load balancer subnet, when one was requested (Azure only). Omitted otherwise.
  - `cursor` Cursor, required
    - `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

- `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.

## Changes

- **2026-08-06** `e67df5d1f74e`: 1 info
  - added the optional property `data/items/loadBalancerCidr` to the response with the `200` status

[Operation history](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/changes/v4/organizations/:organizationId/appservices/get.md)

---

[API](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api.md) - [All operations](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/revisions/a5e88bcf71cb?raw)