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

The fine-grained token must include the following permissions to access this endpoint:

  • organization_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)

{
  "projects": [
    {
      "ref": "lorem",
      "name": "lorem",
      "cloud_provider": "lorem",
      "region": "lorem",
      "is_branch": true,
      "status": "INACTIVE",
      "inserted_at": "lorem",
      "databases": [
        {
          "infra_compute_size": "pico",
          "region": "lorem",
          "status": "ACTIVE_HEALTHY",
          "cloud_provider": "lorem",
          "identifier": "lorem",
          "type": "PRIMARY",
          "disk_volume_size_gb": 42,
          "disk_type": "gp3",
          "disk_throughput_mbps": 42,
          "disk_last_modified_at": "lorem"
        }
      ]
    }
  ],
  "pagination": {
    "count": 42,
    "limit": 42,
    "offset": 42
  }
}