Account
Get onboarding progress
Returns the onboarding checklist progress for an organization.
At a glance
| Item | Value |
|---|---|
| Method | GET |
| Path | /v1/organizations/{org_id}/onboarding |
| 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/organizations/<org_id>/onboarding" \
-H "Authorization: Bearer $PGBEAM_TOKEN"AuthorizationBearer <token>
JWT issued by Better Auth. Verified via JWKS.
In: header
Path Parameters
org_id*string
Unique organization identifier.
Match
^[a-zA-Z0-9_.-]+$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.pgbeam.com/v1/organizations/string/onboarding"{
"organization_id": "string",
"org_created": true,
"project_created": true,
"database_added": true,
"connection_tested": true,
"connection_string_copied": true,
"first_query_run": true,
"dismissed": true,
"completed": true,
"steps_completed": 0,
"steps_total": 0,
"completed_at": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}