organizations.listOrganizations

GET

/v1/organizations

const url = 'https://example.com/v1/organizations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/organizations \
  --header 'Authorization: Bearer <token>'

Lists the organizations where you are a member. A user token sees only its own organization.

Authorizations

token
session

Responses

200

Success

application/json

object

items

required

Array<object>

object

required

string

name

required

string

status

required

string

Allowed values: active suspended

createdAt

required

string

Example

{
  "items": [
    {
      "status": "active"
    }
  ]
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

MembershipRequired | ForbiddenOrigin

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: MembershipRequired

Example

{
  "_tag": "MembershipRequired"
}

503

OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: OrganizationStorageUnavailable

Example

{
  "_tag": "OrganizationStorageUnavailable"
}