---
title: "List App Instances"
method: GET
path: "/v2/app-instances"
tags: ["App Instance API"]
---

# List App Instances

`GET /v2/app-instances`

List app instances owned by the team along with those shared with it.

## Query parameters

- `teamId` string — The ID of the team.
- `pageSize` integer — Maximum number of results to return. Default is 10000, maximum is 10000.
- `pageToken` string — Token for pagination. Leave empty for the first request.

## Response `200`

Success

- SvflowPublicapiListAppInstancesResponse
  - `data` SvflowPubapimodelsAppInstance[] — The list of app instances.
    - `customServiceId` string — **Option: custom_service_id** — The ID of the custom service (for custom apps).
    - `service` string — **Option: service** — The service identifier (for built-in services like "github", "okta", "aws").
    - `id` string — The ID of the app instance.
    - `teamId` string — The ID of the Serval team that owns the app instance. For instances returned by ListAppInstances because they are shared with the requesting team, this is the owning team's ID and will differ from the request team_id.
    - `externalServiceInstanceId` string — The external service instance ID (e.g., GitHub org name, Okta domain, AWS account ID).
    - `name` string — The name of the app instance.
    - `accessRequestsEnabled` boolean — Whether access requests are enabled for the app instance.
    - `defaultAccessPolicyId` string, nullable — The default access policy for the app instance.
    - `customServiceName` string — The display name of the custom service (only set when service_type is custom_service_id).
    - `tagIds` string[] — IDs of the tags currently attached to this app instance.
  - `nextPageToken` string, nullable — Token for retrieving the next page of results. Empty if no more results.

## Other responses

- `default` — Error

---

[API](https://skmtc.net/serval/apis/serval-public-api.md) · [All operations](https://skmtc.net/serval/apis/serval-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/serval/serval-public-api/versions/0549515e9384/schema)
