Get Workspace by ID
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/{id}{
"response": {
"id": "org123",
"name": "myworkspace",
"description": "I have a description :)",
"tags": ["discord", "programming"],
"owner_id": "993591427428790342",
"plan_id": 1,
"members": [
{
"user_id": "993591427428790342",
"role": "owner",
"joined_at": "2026-03-14T19:58:00Z"
}
],
"applications": [
{
"id": "v111d4af8cd74272a284831fbae14a8v",
"cluster": 1,
"type": 1,
"name": "Simple API",
"description": "I have a description :)",
"owner_id": "993591427428790342",
"owner_plan_id": 1,
"language": "javascript",
"ram": 128,
"status": "up",
"subdomain": null,
"custom_domain": null,
"last_snapshot": "2026-03-09T15:51:47.234Z",
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-11T15:06:41.449Z"
}
],
"databases": [
{
"id": "639d9aa35d8b4e559bcd066db4ddcc8c",
"cluster": 1,
"type": 3,
"name": "MyDatabase",
"description": "I have a description :)",
"owner_id": "993591427428790342",
"owner_plan_id": 1,
"status": "up",
"ram": 256,
"host": "639d9aa35d8b4e559bcd066db4ddcc8c.db.usa1.vertraweb.app",
"port": 12748,
"last_snapshot": "2026-03-14T19:58:00Z",
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
],
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
}
Workspaces
Get Workspace by ID
Retrieves details of an workspace by its ID.
GET
/
v1
/
workspaces
/
{id}
Get Workspace by ID
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/{id}{
"response": {
"id": "org123",
"name": "myworkspace",
"description": "I have a description :)",
"tags": ["discord", "programming"],
"owner_id": "993591427428790342",
"plan_id": 1,
"members": [
{
"user_id": "993591427428790342",
"role": "owner",
"joined_at": "2026-03-14T19:58:00Z"
}
],
"applications": [
{
"id": "v111d4af8cd74272a284831fbae14a8v",
"cluster": 1,
"type": 1,
"name": "Simple API",
"description": "I have a description :)",
"owner_id": "993591427428790342",
"owner_plan_id": 1,
"language": "javascript",
"ram": 128,
"status": "up",
"subdomain": null,
"custom_domain": null,
"last_snapshot": "2026-03-09T15:51:47.234Z",
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-11T15:06:41.449Z"
}
],
"databases": [
{
"id": "639d9aa35d8b4e559bcd066db4ddcc8c",
"cluster": 1,
"type": 3,
"name": "MyDatabase",
"description": "I have a description :)",
"owner_id": "993591427428790342",
"owner_plan_id": 1,
"status": "up",
"ram": 256,
"host": "639d9aa35d8b4e559bcd066db4ddcc8c.db.usa1.vertraweb.app",
"port": 12748,
"last_snapshot": "2026-03-14T19:58:00Z",
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
],
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
}
The ID of the workspace to retrieve.
Response
The details of the workspace.
Show Toggle object
Show Toggle object
The ID of the workspace.
The name of the workspace.
The description of the workspace.
The tags associated with the workspace.
The ID of the workspace owner.
The ID of the owner’s plan.
An array of application objects associated with the workspace.
Show Toggle object
Show Toggle object
The ID of the application.
The ID of the application owner.
The ID of the owner’s plan.
The type of the application.
The status of the application (e.g.,
up).The cluster ID where the application is hosted.
The programming language of the application.
The subdomain of the application.
The custom domain of the application, if set.
The timestamp when the application was created.
The timestamp when the application was last updated.
The timestamp of the last snapshot.
An array of database objects associated with the workspace.
Show Toggle object
Show Toggle object
The ID of the database.
The ID of the database owner.
The ID of the owner’s plan.
The type of the database.
The cluster ID where the database is hosted.
The status of the database (e.g.,
up).The host address of the database.
The port used by the database.
The timestamp when the database was created.
The timestamp when the database was last updated.
The timestamp of the last snapshot, if available.
The timestamp when the workspace was created.
The timestamp when the workspace was last updated.
{
"response": {
"id": "org123",
"name": "myworkspace",
"description": "I have a description :)",
"tags": ["discord", "programming"],
"owner_id": "993591427428790342",
"plan_id": 1,
"members": [
{
"user_id": "993591427428790342",
"role": "owner",
"joined_at": "2026-03-14T19:58:00Z"
}
],
"applications": [
{
"id": "v111d4af8cd74272a284831fbae14a8v",
"cluster": 1,
"type": 1,
"name": "Simple API",
"description": "I have a description :)",
"owner_id": "993591427428790342",
"owner_plan_id": 1,
"language": "javascript",
"ram": 128,
"status": "up",
"subdomain": null,
"custom_domain": null,
"last_snapshot": "2026-03-09T15:51:47.234Z",
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-11T15:06:41.449Z"
}
],
"databases": [
{
"id": "639d9aa35d8b4e559bcd066db4ddcc8c",
"cluster": 1,
"type": 3,
"name": "MyDatabase",
"description": "I have a description :)",
"owner_id": "993591427428790342",
"owner_plan_id": 1,
"status": "up",
"ram": 256,
"host": "639d9aa35d8b4e559bcd066db4ddcc8c.db.usa1.vertraweb.app",
"port": 12748,
"last_snapshot": "2026-03-14T19:58:00Z",
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
],
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
}
Error Responses
The error code indicating the reason for failure. Possible values:
UNAUTHORIZED: The user is not authenticated.ORGANIZATION_NOT_FOUND: The specified workspace does not exist.NOT_ORGANIZATION_MEMBER: The user is not a member of the workspace.
A descriptive message providing additional details about the error.
{
"code": "UNAUTHORIZED"
}
⌘I