Overview
The Groundfloor REST API — base URL, authentication, errors and every resource.
Everything you can do in the Client Portal, you can do with the Groundfloor API: a JSON REST API over HTTPS.
Base URL
https://platform.groundfloor.cloudAlmost everything lives under a workspace:
https://platform.groundfloor.cloud/v1/workspaces/{workspace_id}/…Find a workspace's ID on its page in the Client Portal, or with gf workspaces.
Make your first request
TOKEN=$(gf token)
curl -H "Authorization: Bearer $TOKEN" "https://platform.groundfloor.cloud/v1/workspaces"Every request needs a bearer token, except getting an M2M token. See Authentication for which token to use.
Errors
Errors return a JSON body:
{ "detail": "A human-readable message" }| Status | Meaning |
|---|---|
400 | The request is invalid, for example a reserved name |
401 | The token is missing, malformed or expired |
403 | The token is valid, but its role can't do this |
404 | It doesn't exist, or you can't see it |
409 | It conflicts with the current state, for example a plan limit |
422 | A field failed validation |
429 | Too many requests; wait and retry |
Resources
| Area | API |
|---|---|
| Your organization and team | Organizations · Workspaces · Environments · Memberships · Quotas · Support |
| Deploy | Coderunners · Apps · Process log |
| Data | Data Vault · Files · Managed databases |
| Configure | Secrets · Feature flags · LLM Gateway (coming soon) |
| Access | Authentication · M2M · Workspace sign-in · Site access · Audit |
OpenAPI
The full machine-readable description is at https://platform.groundfloor.cloud/openapi.json. Generate a client from it, or import it into an API tool.