GET
/
v1
/
organizations
/
{id}
Get Organization by ID
curl --request GET \
  --url https://api.vertracloud.app/v1/organizations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}
id
string
required
The ID of the organization to retrieve.

Response

status
string
Indicates whether the call was successful. success if successful, error if not.
response
object
The details of the organization.
{
  "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

status
string
Indicates whether the call was successful. error if not successful.
code
string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated.
  • ORGANIZATION_NOT_FOUND: The specified organization does not exist.
  • NOT_ORGANIZATION_MEMBER: The user is not a member of the organization.
{
  "status": "error",
  "code": "UNAUTHORIZED"
}