Skip to content
Management API Reference

Gets all projects for the given organization

get/v1/organizations/{slug}/projects

Returns a paginated list of projects for the specified organization.

This endpoint uses offset-based pagination. Use the offset parameter to skip a number of projects and the limit parameter to control the number of projects returned per page.

OAuth scopes

  • projects:read

Path parameters

  • slug
    Required
    string

    Organization slug

Query parameters

  • offset
    Optional
    integer

    Number of projects to skip

  • limit
    Optional
    integer

    Number of projects to return per page

  • search
    Optional
    string

    Search projects by name

  • sort
    Optional
    enum

    Sort order for projects

  • statuses
    Optional
    string

    A comma-separated list of project statuses to filter by.

    The following values are supported: ACTIVE_HEALTHY, INACTIVE.

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

1
{
2
  "projects": [
3
    {
4
      "ref": "lorem",
5
      "name": "lorem",
6
      "cloud_provider": "lorem",
7
      "region": "lorem",
8
      "is_branch": true,
9
      "status": "INACTIVE",
10
      "inserted_at": "lorem",
11
      "databases": [
12
        {
13
          "infra_compute_size": "pico",
14
          "region": "lorem",
15
          "status": "ACTIVE_HEALTHY",
16
          "cloud_provider": "lorem",
17
          "identifier": "lorem",
18
          "type": "PRIMARY",
19
          "disk_volume_size_gb": 42,
20
          "disk_type": "gp3",
21
          "disk_throughput_mbps": 42,
22
          "disk_last_modified_at": "lorem"
23
        }
24
      ]
25
    }
26
  ],
27
  "pagination": {
28
    "count": 42,
29
    "limit": 42,
30
    "offset": 42
31
  }
32
}