platform.listPlatformOrganizations

GET

/v1/platform/organizations

const url = 'https://example.com/v1/platform/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/platform/organizations \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Query Parameters

after

string

limit

string

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

next

required

Any of:

string
null

string

Example

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

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

409

@nmnmcc/ability/Authorizer/Pending

application/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

503

PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PlatformUnavailable

Example

{
  "_tag": "PlatformUnavailable"
}