---
title: "List a project's services"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Run API

`GET /v1/organizations/{orgId}/projects/{projectId}/services`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `ListServices.path.orgId` (string, required) — UUID or prefixed ID (org_…)
- `ListServices.path.projectId` (string, required) — UUID or prefixed ID (prj_…)

## Query parameters

- `ListServices.query.limit` (integer, optional) — The page size. Out of range is 400, never a clamp.
  - min 1; max 100; default `20`
- `ListServices.query.cursor` (string, optional) — The previous page's nextCursor. Bound to the organization, the list and its filters.

## Code samples

### cURL

```curl
curl --request GET \
  --url https://run.ezghcloud.com/v1/organizations/string/projects/string/services \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://run.ezghcloud.com/v1/organizations/string/projects/string/services';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://run.ezghcloud.com/v1/organizations/string/projects/string/services"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

A page of services.

#### Example

```json
{
  "nextCursor": "string",
  "services": [
    {
      "access": "public",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "ingress": "all",
      "latestReadyRevisionId": "string",
      "latestRevisionId": "string",
      "loadBalancerTargetGroups": [
        "string"
      ],
      "name": "string",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
      "region": "string",
      "resourceName": "string",
      "slug": "string",
      "status": "deploying",
      "traffic": [
        {
          "percent": 100,
          "revision": "string"
        }
      ],
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string"
    }
  ]
}
```

- `ListServices.response.200.nextCursor` (string | null, required)
- `ListServices.response.200.services` (array<object>, required)
  - `ListServices.response.200.services.access` (unknown, required)
    - one of `"public"`, `"authenticated"`
  - `ListServices.response.200.services.createdAt` (string, required)
    - format `date-time`
  - `ListServices.response.200.services.id` (string, required)
    - format `uuid`
  - `ListServices.response.200.services.ingress` (unknown, required) — all: the run URL and bound load balancers. loadBalancers: only load balancers whose target group is bound to the service; the service has no URL (url is null) until all restores the same URL.
    - one of `"all"`, `"loadBalancers"`
  - `ListServices.response.200.services.latestReadyRevisionId` (string | null, required) — The latest ready revision's rrv_ ID: what "latest" in traffic sends to.
  - `ListServices.response.200.services.latestRevisionId` (string | null, required) — The latest revision's rrv_ ID.
  - `ListServices.response.200.services.loadBalancerTargetGroups` (array<string>, required) — The load balancer target groups (tgp_ IDs) bound to the service, sorted.
  - `ListServices.response.200.services.name` (string, required)
  - `ListServices.response.200.services.organizationId` (string, required)
    - format `uuid`
  - `ListServices.response.200.services.projectId` (string, required)
    - format `uuid`
  - `ListServices.response.200.services.region` (string, required)
  - `ListServices.response.200.services.resourceName` (string, required)
  - `ListServices.response.200.services.slug` (string, required) — The service's rsv_ ID.
  - `ListServices.response.200.services.status` (unknown, required)
    - one of `"deploying"`, `"ready"`, `"failed"`, `"deleting"`
  - `ListServices.response.200.services.traffic` (array<object>, required) — Entries sum to 100.
    - `ListServices.response.200.services.traffic.percent` (integer, required)
      - min 0; max 100
    - `ListServices.response.200.services.traffic.revision` (string, required) — "latest" (the latest ready revision) or a ready revision's rrv_ ID.
  - `ListServices.response.200.services.updatedAt` (string, required)
    - format `date-time`
  - `ListServices.response.200.services.url` (string | null, required) — https://<name>-<6 random>.run.<region>.ezghapps.com. null while ingress is loadBalancers: the service has no URL then, and its hostname answers as an unknown one. Setting ingress back to all restores the same URL.

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListServices.response.400.error` (object, required)
  - `ListServices.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListServices.response.400.error.message` (string, required)
    - maxLength 1024
  - `ListServices.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListServices.response.400.error.issues.message` (string, required)
    - `ListServices.response.400.error.issues.path` (string, required)
  - `ListServices.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListServices.response.400.error.quota.id` (string, required)
    - `ListServices.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListServices.response.400.error.quota.limit` (integer, required)
      - min 0
    - `ListServices.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListServices.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListServices.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListServices.response.400.error.quota.region` (string, optional)
    - `ListServices.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListServices.response.400.error.quota.scopeResourceName` (string, optional)
    - `ListServices.response.400.error.quota.used` (integer, optional)
      - min 0
    - `ListServices.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListServices.response.401.error` (object, required)
  - `ListServices.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListServices.response.401.error.message` (string, required)
    - maxLength 1024
  - `ListServices.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListServices.response.401.error.issues.message` (string, required)
    - `ListServices.response.401.error.issues.path` (string, required)
  - `ListServices.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListServices.response.401.error.quota.id` (string, required)
    - `ListServices.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListServices.response.401.error.quota.limit` (integer, required)
      - min 0
    - `ListServices.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListServices.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListServices.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListServices.response.401.error.quota.region` (string, optional)
    - `ListServices.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListServices.response.401.error.quota.scopeResourceName` (string, optional)
    - `ListServices.response.401.error.quota.used` (integer, optional)
      - min 0
    - `ListServices.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListServices.response.403.error` (object, required)
  - `ListServices.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListServices.response.403.error.message` (string, required)
    - maxLength 1024
  - `ListServices.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListServices.response.403.error.issues.message` (string, required)
    - `ListServices.response.403.error.issues.path` (string, required)
  - `ListServices.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListServices.response.403.error.quota.id` (string, required)
    - `ListServices.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListServices.response.403.error.quota.limit` (integer, required)
      - min 0
    - `ListServices.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListServices.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListServices.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListServices.response.403.error.quota.region` (string, optional)
    - `ListServices.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListServices.response.403.error.quota.scopeResourceName` (string, optional)
    - `ListServices.response.403.error.quota.used` (integer, optional)
      - min 0
    - `ListServices.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListServices.response.404.error` (object, required)
  - `ListServices.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListServices.response.404.error.message` (string, required)
    - maxLength 1024
  - `ListServices.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListServices.response.404.error.issues.message` (string, required)
    - `ListServices.response.404.error.issues.path` (string, required)
  - `ListServices.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListServices.response.404.error.quota.id` (string, required)
    - `ListServices.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListServices.response.404.error.quota.limit` (integer, required)
      - min 0
    - `ListServices.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListServices.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListServices.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListServices.response.404.error.quota.region` (string, optional)
    - `ListServices.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListServices.response.404.error.quota.scopeResourceName` (string, optional)
    - `ListServices.response.404.error.quota.used` (integer, optional)
      - min 0
    - `ListServices.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListServices.response.429.error` (object, required)
  - `ListServices.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListServices.response.429.error.message` (string, required)
    - maxLength 1024
  - `ListServices.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListServices.response.429.error.issues.message` (string, required)
    - `ListServices.response.429.error.issues.path` (string, required)
  - `ListServices.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListServices.response.429.error.quota.id` (string, required)
    - `ListServices.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListServices.response.429.error.quota.limit` (integer, required)
      - min 0
    - `ListServices.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListServices.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListServices.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListServices.response.429.error.quota.region` (string, optional)
    - `ListServices.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListServices.response.429.error.quota.scopeResourceName` (string, optional)
    - `ListServices.response.429.error.quota.used` (integer, optional)
      - min 0
    - `ListServices.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListServices.response.500.error` (object, required)
  - `ListServices.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListServices.response.500.error.message` (string, required)
    - maxLength 1024
  - `ListServices.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListServices.response.500.error.issues.message` (string, required)
    - `ListServices.response.500.error.issues.path` (string, required)
  - `ListServices.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListServices.response.500.error.quota.id` (string, required)
    - `ListServices.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListServices.response.500.error.quota.limit` (integer, required)
      - min 0
    - `ListServices.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListServices.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListServices.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListServices.response.500.error.quota.region` (string, optional)
    - `ListServices.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListServices.response.500.error.quota.scopeResourceName` (string, optional)
    - `ListServices.response.500.error.quota.used` (integer, optional)
      - min 0
    - `ListServices.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListServices.response.503.error` (object, required)
  - `ListServices.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListServices.response.503.error.message` (string, required)
    - maxLength 1024
  - `ListServices.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListServices.response.503.error.issues.message` (string, required)
    - `ListServices.response.503.error.issues.path` (string, required)
  - `ListServices.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListServices.response.503.error.quota.id` (string, required)
    - `ListServices.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListServices.response.503.error.quota.limit` (integer, required)
      - min 0
    - `ListServices.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListServices.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListServices.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListServices.response.503.error.quota.region` (string, optional)
    - `ListServices.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListServices.response.503.error.quota.scopeResourceName` (string, optional)
    - `ListServices.response.503.error.quota.used` (integer, optional)
      - min 0
    - `ListServices.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/run-api/ListServices/index.md
