List organization projects | Management API Reference

List projects of an organization

get/v2/organizations/{slug}/projects

Returns a cursor-paginated list of projects for the specified organization, including their databases.

Use page[after] and page[before] to navigate pages and page[size] 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

page
Optional
object
sort
Optional
enum
Sort order by creation time: inserted_at (oldest first) or -inserted_at (newest first). Defaults to inserted_at.
search
Optional
string
Case-insensitive substring match on the project name.

Response codes

Response (200)

1
{
2
  "data": [
3
    {
4
      "type": "project",
5
      "id": "abcdefghijklmnopqrst",
6
      "attributes": {
7
        "name": "lorem",
8
        "status": "INACTIVE",
9
        "cloud_provider": "lorem",
10
        "region": "lorem",
11
        "inserted_at": "lorem",
12
        "databases": [
13
          {
14
            "cloud_provider": "lorem",
15
            "identifier": "lorem",
16
            "region": "lorem",
17
            "status": "ACTIVE_HEALTHY",
18
            "type": "PRIMARY",
19
            "infra_compute_size": "pico",
20
            "disk_volume_size_gb": 42,
21
            "disk_type": "gp3",
22
            "disk_throughput_mbps": 42,
23
            "disk_last_modified_at": "lorem"
24
          }
25
        ]
26
      }
27
    }
28
  ],
29
  "links": {
30
    "first": "/v2/organizations/my-org/projects?page[size]=10",
31
    "prev": "/v2/organizations/my-org/projects?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
32
    "next": "/v2/organizations/my-org/projects?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
33
    "last": "/v2/organizations/my-org/projects?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
34
  }
35
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "array",
6
      "items": {
7
        "type": "object",
8
        "properties": {
9
          "type": {
10
            "type": "string",
11
            "description": "Resource type.",
12
            "enum": [
13
              "project"
14
            ]
15
          },
16
          "id": {
17
            "type": "string",
18
            "minLength": 20,
19
            "maxLength": 20,
20
            "pattern": "^[a-z]+$",
21
            "description": "Project ref",
22
            "example": "abcdefghijklmnopqrst"
23
          },
24
          "attributes": {
25
            "type": "object",
26
            "properties": {
27
              "name": {
28
                "type": "string",
29
                "description": "Project name"
30
              },
31
              "status": {
32
                "type": "string",
33
                "enum": [
34
                  "INACTIVE",
35
                  "ACTIVE_HEALTHY",
36
                  "ACTIVE_UNHEALTHY",
37
                  "COMING_UP",
38
                  "UNKNOWN",
39
                  "GOING_DOWN",
40
                  "INIT_FAILED",
41
                  "REMOVED",
42
                  "RESTORING",
43
                  "UPGRADING",
44
                  "PAUSING",
45
                  "RESTORE_FAILED",
46
                  "RESTARTING",
47
                  "PAUSE_FAILED",
48
                  "RESIZING"
49
                ],
50
                "description": "Project status"
51
              },
52
              "cloud_provider": {
53
                "type": "string",
54
                "description": "Cloud provider hosting the project"
55
              },
56
              "region": {
57
                "type": "string",
58
                "description": "Region the project is hosted in"
59
              },
60
              "inserted_at": {
61
                "type": "string",
62
                "description": "When the project was created"
63
              },
64
              "databases": {
65
                "type": "array",
66
                "items": {
67
                  "type": "object",
68
                  "properties": {
69
                    "cloud_provider": {
70
                      "type": "string"
71
                    },
72
                    "identifier": {
73
                      "type": "string"
74
                    },
75
                    "region": {
76
                      "type": "string",
77
                      "nullable": true
78
                    },
79
                    "status": {
80
                      "type": "string",
81
                      "enum": [
82
                        "ACTIVE_HEALTHY",
83
                        "ACTIVE_UNHEALTHY",
84
                        "COMING_UP",
85
                        "GOING_DOWN",
86
                        "INIT_FAILED",
87
                        "REMOVED",
88
                        "RESTORING",
89
                        "UNKNOWN",
90
                        "INIT_READ_REPLICA",
91
                        "INIT_READ_REPLICA_FAILED",
92
                        "RESTARTING",
93
                        "RESIZING"
94
                      ]
95
                    },
96
                    "type": {
97
                      "type": "string",
98
                      "enum": [
99
                        "PRIMARY",
100
                        "READ_REPLICA"
101
                      ]
102
                    },
103
                    "infra_compute_size": {
104
                      "type": "string",
105
                      "enum": [
106
                        "pico",
107
                        "nano",
108
                        "micro",
109
                        "small",
110
                        "medium",
111
                        "large",
112
                        "xlarge",
113
                        "2xlarge",
114
                        "4xlarge",
115
                        "8xlarge",
116
                        "12xlarge",
117
                        "16xlarge",
118
                        "24xlarge",
119
                        "24xlarge_optimized_memory",
120
                        "24xlarge_optimized_cpu",
121
                        "24xlarge_high_memory",
122
                        "48xlarge",
123
                        "48xlarge_optimized_memory",
124
                        "48xlarge_optimized_cpu",
125
                        "48xlarge_high_memory"
126
                      ]
127
                    },
128
                    "disk_volume_size_gb": {
129
                      "type": "number"
130
                    },
131
                    "disk_type": {
132
                      "type": "string",
133
                      "enum": [
134
                        "gp3",
135
                        "io2"
136
                      ]
137
                    },
138
                    "disk_throughput_mbps": {
139
                      "type": "number"
140
                    },
141
                    "disk_last_modified_at": {
142
                      "type": "string"
143
                    }
144
                  },
145
                  "required": [
146
                    "cloud_provider",
147
                    "identifier",
148
                    "region",
149
                    "status",
150
                    "type"
151
                  ]
152
                },
153
                "description": "The project's databases including compute and disk attributes."
154
              }
155
            },
156
            "required": [
157
              "name",
158
              "status",
159
              "cloud_provider",
160
              "region",
161
              "inserted_at",
162
              "databases"
163
            ]
164
          }
165
        },
166
        "required": [
167
          "type",
168
          "id",
169
          "attributes"
170
        ]
171
      }
172
    },
173
    "links": {
174
      "type": "object",
175
      "properties": {
176
        "first": {
177
          "type": "string",
178
          "description": "URL path to the first page if available.",
179
          "example": "/v2/organizations/my-org/projects?page[size]=10",
180
          "nullable": true
181
        },
182
        "prev": {
183
          "type": "string",
184
          "description": "URL path to the previous page.",
185
          "example": "/v2/organizations/my-org/projects?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
186
          "nullable": true
187
        },
188
        "next": {
189
          "type": "string",
190
          "description": "URL path to the next page.",
191
          "example": "/v2/organizations/my-org/projects?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
192
          "nullable": true
193
        },
194
        "last": {
195
          "type": "string",
196
          "description": "URL path to the last page if available.",
197
          "example": "/v2/organizations/my-org/projects?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295",
198
          "nullable": true
199
        }
200
      },
201
      "required": [
202
        "prev",
203
        "next"
204
      ]
205
    }
206
  },
207
  "required": [
208
    "data",
209
    "links"
210
  ]
211
}