The ID of the user whose organizations are to be retrieved. Use
@me to refer to the authenticated user.Response
Indicates whether the call was successful.
success if successful, error if not.An array of organization objects.
Show Toggle object
Show Toggle object
The ID of the organization.
The name of the organization.
The description of the organization.
The tags associated with the organization.
The ID of the organization owner.
The ID of the owner’s plan.
An array of application objects associated with the organization.
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 commit.
The timestamp of the last backup, if available.
An array of database objects associated with the organization.
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 ID of the database plan.
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 when the database was purchased.
The timestamp when the database subscription expires.
The timestamp of the last backup, if available.
The timestamp when the organization was created.
The timestamp when the organization was last updated.
Copy
{
"status": "success",
"response": [
{
"id": "org123",
"name": "myorganization",
"description": "I have a description :)",
"tags": ["discord", "programming"],
"owner_id": "993591427428790342",
"plan_id": 1,
"members": [
{
"user_id": "993591427428790342",
"role": "owner",
"joined_at": "2025-08-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": "nodejs",
"ram": 128,
"status": "up",
"subdomain": null,
"custom_domain": null,
"last_commit": "2025-08-09T15:51:47.234Z",
"last_backup": null,
"created_at": "2025-08-09T15:51:47.234Z",
"updated_at": "2025-08-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",
"storage": 512,
"ram": 256,
"host": "vertra-cloud-redis-639d9aa35d8b4e559bcd066db4ddcc8c.db.vertraweb.app",
"port": 6379,
"duration": 30,
"expires_at": "2025-09-14T19:58:00Z",
"plan_id": 1,
"purchased_at": "2025-08-14T19:58:00Z",
"last_backup": "2025-08-14T19:58:00Z",
"created_at": "2025-08-14T19:58:00Z",
"updated_at": "2025-08-14T19:58:00Z"
}
],
"created_at": "2025-08-14T19:58:00Z",
"updated_at": "2025-08-14T19:58:00Z"
}
]
}
Error Responses
Indicates whether the call was successful.
error if not successful.The error code indicating the reason for failure. Possible values:
UNAUTHORIZED: The user is not authenticated.USER_NOT_FOUND: The specified user does not exist.ID_MUST_BE_A_STRING: The provided user ID is not a string.
Copy
{
"status": "error",
"code": "USER_NOT_FOUND"
}