List the organizations the user belongs to

GET

/v1/org/list

const url = 'https://your-tenant-host/v1/org/list';
const options = {
  method: 'GET',
  headers: {
    cookie: 'ek.session_token=<ek.session_token>',
    'x-edgekit-site-id': 'site_example'
  }
};

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://your-tenant-host/v1/org/list \
  --header 'x-edgekit-site-id: site_example' \
  --cookie ek.session_token=<ek.session_token>

Every organization the signed-in user holds a membership in. Empty for a user who represents only themselves, which is most of them.

Authorizations

UserSession

Parameters

Header Parameters

x-edgekit-site-id

required

The site this request is for, within this tenant. Every official EdgeKit SDK sets it from the client you configured; set it yourself only when calling this API directly.

string

>= 1 characters <= 128 characters

Example

site_example

The site this request is for, within this tenant. Every official EdgeKit SDK sets it from the client you configured; set it yourself only when calling this API directly.

Responses

200

The user’s organizations.

application/json

object

organizations

required

Array<object>

object

required

string format: uuid

name

required

string

slug

required

string

logo

required

string | null

Example

{
  "organizations": [
    {
      "id": "01926f3a-8b4e-7b33-a944-5e6f7a8b9c0d",
      "name": "Aperture Science",
      "slug": "aperture-science",
      "logo": null
    }
  ]
}

400

Invalid request.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

401

Missing or invalid credential.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

403

Not allowed.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

404

Resource not found.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

422

Request validation failed.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

500

Unexpected error.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}