Get all projects for organization | 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

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
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "projects": {
5
      "type": "array",
6
      "items": {
7
        "type": "object",
8
        "properties": {
9
          "ref": {
10
            "type": "string"
11
          },
12
          "name": {
13
            "type": "string"
14
          },
15
          "cloud_provider": {
16
            "type": "string"
17
          },
18
          "region": {
19
            "type": "string"
20
          },
21
          "is_branch": {
22
            "type": "boolean"
23
          },
24
          "status": {
25
            "type": "string",
26
            "enum": [
27
              "INACTIVE",
28
              "ACTIVE_HEALTHY",
29
              "ACTIVE_UNHEALTHY",
30
              "COMING_UP",
31
              "UNKNOWN",
32
              "GOING_DOWN",
33
              "INIT_FAILED",
34
              "REMOVED",
35
              "RESTORING",
36
              "UPGRADING",
37
              "PAUSING",
38
              "RESTORE_FAILED",
39
              "RESTARTING",
40
              "PAUSE_FAILED",
41
              "RESIZING"
42
            ]
43
          },
44
          "inserted_at": {
45
            "type": "string"
46
          },
47
          "databases": {
48
            "type": "array",
49
            "items": {
50
              "type": "object",
51
              "properties": {
52
                "infra_compute_size": {
53
                  "type": "string",
54
                  "enum": [
55
                    "pico",
56
                    "nano",
57
                    "micro",
58
                    "small",
59
                    "medium",
60
                    "large",
61
                    "xlarge",
62
                    "2xlarge",
63
                    "4xlarge",
64
                    "8xlarge",
65
                    "12xlarge",
66
                    "16xlarge",
67
                    "24xlarge",
68
                    "24xlarge_optimized_memory",
69
                    "24xlarge_optimized_cpu",
70
                    "24xlarge_high_memory",
71
                    "48xlarge",
72
                    "48xlarge_optimized_memory",
73
                    "48xlarge_optimized_cpu",
74
                    "48xlarge_high_memory"
75
                  ]
76
                },
77
                "region": {
78
                  "type": "string"
79
                },
80
                "status": {
81
                  "type": "string",
82
                  "enum": [
83
                    "ACTIVE_HEALTHY",
84
                    "ACTIVE_UNHEALTHY",
85
                    "COMING_UP",
86
                    "GOING_DOWN",
87
                    "INIT_FAILED",
88
                    "REMOVED",
89
                    "RESTORING",
90
                    "UNKNOWN",
91
                    "INIT_READ_REPLICA",
92
                    "INIT_READ_REPLICA_FAILED",
93
                    "RESTARTING",
94
                    "RESIZING"
95
                  ]
96
                },
97
                "cloud_provider": {
98
                  "type": "string"
99
                },
100
                "identifier": {
101
                  "type": "string"
102
                },
103
                "type": {
104
                  "type": "string",
105
                  "enum": [
106
                    "PRIMARY",
107
                    "READ_REPLICA"
108
                  ]
109
                },
110
                "disk_volume_size_gb": {
111
                  "type": "number"
112
                },
113
                "disk_type": {
114
                  "type": "string",
115
                  "enum": [
116
                    "gp3",
117
                    "io2"
118
                  ]
119
                },
120
                "disk_throughput_mbps": {
121
                  "type": "number"
122
                },
123
                "disk_last_modified_at": {
124
                  "type": "string"
125
                }
126
              },
127
              "required": [
128
                "region",
129
                "status",
130
                "cloud_provider",
131
                "identifier",
132
                "type"
133
              ]
134
            }
135
          }
136
        },
137
        "required": [
138
          "ref",
139
          "name",
140
          "cloud_provider",
141
          "region",
142
          "is_branch",
143
          "status",
144
          "inserted_at",
145
          "databases"
146
        ]
147
      }
148
    },
149
    "pagination": {
150
      "type": "object",
151
      "properties": {
152
        "count": {
153
          "type": "number",
154
          "description": "Total number of projects. Use this to calculate the total number of pages."
155
        },
156
        "limit": {
157
          "type": "number",
158
          "description": "Maximum number of projects per page"
159
        },
160
        "offset": {
161
          "type": "number",
162
          "description": "Number of projects skipped in this response"
163
        }
164
      },
165
      "required": [
166
        "count",
167
        "limit",
168
        "offset"
169
      ]
170
    }
171
  },
172
  "required": [
173
    "projects",
174
    "pagination"
175
  ]
176
}