Projects
List projects
Lists projects filtered by organization. Requires org_id query parameter.
At a glance
| Item | Value |
|---|---|
| Method | GET |
| Path | /v1/projects |
| Auth | Authorization: Bearer <token-or-api-key> |
Quick request
Use this as a starting point. Replace the placeholder IDs and set PGBEAM_TOKEN
if the endpoint requires auth.
curl -X GET \
"$PGBEAM_API_URL/v1/projects" \
-H "Authorization: Bearer $PGBEAM_TOKEN"AuthorizationBearer <token>
JWT issued by Better Auth. Verified via JWKS.
In: header
Query Parameters
org_id*string
Organization ID to filter projects.
Match
^[\x20-\x7E]+$page_size?integer
Maximum number of items to return (1-100, default 20).
Default
20Range
1 <= value <= 100page_token?string
Opaque token for cursor-based pagination.
Match
^[a-zA-Z0-9_.-]+$sort_by?string
Sort field for projects list.
Default
"created_at"Value in
"name" | "created_at" | "active_connections"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.pgbeam.com/v1/projects?org_id=org_abc123"{
"projects": [
{
"id": "prj_01h455vb4pex5vsknk084sn02q",
"org_id": "org_abc123",
"name": "my-app",
"description": "Production database proxy",
"tags": [
"production",
"us-east-1"
],
"cloud": "aws",
"proxy_host": "string",
"queries_per_second": 1000,
"burst_size": 200,
"max_connections": 500,
"allowed_cidrs": [
{
"cidr": "10.0.0.0/8",
"label": "VPC"
},
{
"cidr": "2001:db8::/32",
"label": "IPv6 range"
}
],
"database_count": 0,
"active_connections": 0,
"status": "active",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total": 0,
"next_page_token": "string"
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}