Skip to main content
GET
/
organizations
/
{slug}
Get Organization Details
curl --request GET \
  --url https://relytone.data.cloud/api/v1/organizations/{slug} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "members": [
    {
      "id": "<string>",
      "userId": "<string>",
      "role": "owner",
      "user": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "image": "<string>"
      }
    }
  ],
  "projects": [
    {
      "id": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "active",
      "region": "<string>",
      "cloudProvider": "aws",
      "pgVersion": 123,
      "bizId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "organizationId": "<string>",
      "organization": {},
      "branches": [
        {
          "id": "<string>",
          "slug": "<string>",
          "name": "<string>",
          "status": "creating",
          "isPrimary": true,
          "isDefault": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "projectId": "<string>",
          "computes": [
            {
              "id": "<string>",
              "slug": "<string>",
              "name": "<string>",
              "status": "READY",
              "cloudProvider": "aws",
              "instanceType": "<string>",
              "host": "<string>",
              "poolerHost": "<string>",
              "bizId": 123,
              "taskId": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "branchId": "<string>",
              "createUser": {
                "id": "<string>",
                "name": "<string>",
                "email": "<string>"
              }
            }
          ]
        }
      ]
    }
  ],
  "_count": {
    "projects": 123,
    "members": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

slug
string
required

Organization identifier

Response

Successfully retrieved organization details

id
string

Organization unique identifier

slug
string

Organization identifier

name
string

Organization name

description
string

Organization description

createdAt
string<date-time>

Creation time

updatedAt
string<date-time>

Update time

members
object[]
projects
object[]
_count
object
I