Get my organizations

This API returns two list of organizations for the current logged in user. i) The list of orgs which the current user is already a part of ii) The list of organizations the user can join directly (based on domain whitelisted and verified by the org). This list will also contain orgs of which user is already a part of. Note: the domain needs to be verified by the org before the it is returned as one of the joinable orgs by domain

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

organizations object[]
Array [
id string
name string
title string
metadata object
createdAt date-time
The time the organization was created.
updatedAt date-time
The time the organization was last updated.
state string
The state of the organization (enabled or disabled).
avatar string
The base64 encoded image string of the organization avatar. Should be less than 2MB.
]
joinableViaDomain object[]
Array [
id string
name string
title string
metadata object
createdAt date-time
The time the organization was created.
updatedAt date-time
The time the organization was last updated.
state string
The state of the organization (enabled or disabled).
avatar string
The base64 encoded image string of the organization avatar. Should be less than 2MB.
]

{
  "organizations": [
    {
      "id": "string",
      "name": "string",
      "title": "string",
      "metadata": {},
      "createdAt": "2023-06-07T05:39:56.961Z",
      "updatedAt": "2023-06-07T05:39:56.961Z",
      "state": "enabled",
      "avatar": "string"
    }
  ],
  "joinableViaDomain": [
    {
      "id": "string",
      "name": "string",
      "title": "string",
      "metadata": {},
      "createdAt": "2023-06-07T05:39:56.961Z",
      "updatedAt": "2023-06-07T05:39:56.961Z",
      "state": "enabled",
      "avatar": "string"
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...