List all projects

Retrieves a list of all projects within the specified organization that the authenticated user has access to.

GET /organizations/{organizationID}/projects

Try it

List all projects

cURL

curl --request GET \
  --url https://api.xata.tech/organizations/{organizationID}/projects \
  --header 'Authorization: Bearer <token>'

200

{
  "projects": [
    {
      "id": "<string>",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "configuration": {
        "scaleToZero": {
          "baseBranches": {
            "enabled": true,
            "inactivityPeriodMinutes": 30
          },
          "childBranches": {
            "enabled": true,
            "inactivityPeriodMinutes": 30
          }
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organizationID · string · required

Unique identifier of the organization to list projects from

Response

200

application/json

A list of projects within the organization

projects · object[] · required

Array of project objects with their metadata

Show child attributes

projects. id · string · required

Unique identifier for the project

projects. name · string · required

Human-readable name of the project

projects. createdAt · string<date-time> · required

Timestamp when the project was created

projects. updatedAt · string<date-time> · required

Timestamp when the project was last updated

projects. configuration · object · required

Configuration details for a project, including its scale to zero settings

Show child attributes

projects.configuration. scaleToZero · object · required

Whether the project branches are configured to scale down to zero when not in use

Show child attributes

projects.configuration.scaleToZero. baseBranches · object · required

Configuration for scaling branches to zero when not in use

Show child attributes

projects.configuration.scaleToZero.baseBranches. enabled · boolean · required

Whether scale to zero is enabled

projects.configuration.scaleToZero.baseBranches. inactivityPeriodMinutes · integer · default: 30 · required

Duration in minutes after which branches will be hibernated if not accessed

projects.configuration.scaleToZero. childBranches · object · required

Configuration for scaling branches to zero when not in use

Show child attributes

projects.configuration.scaleToZero.childBranches. enabled · boolean · required

Whether scale to zero is enabled

projects.configuration.scaleToZero.childBranches. inactivityPeriodMinutes · integer · default: 30 · required

Duration in minutes after which branches will be hibernated if not accessed