List members API Reference

GET

/tenants/{tenant}/members

curl --request GET \
  --url https://api.kupe.cloud/api/v1/tenants/acme/members \
  --header 'Authorization: <Authorization>'

List all members of a tenant with their email addresses and roles.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

Responses

200

List of members

Media type application/json

object

items

Array<object>

object

email

string

role

string

Example

{
  "items": [
    {
      "email": "alice@acme.com",
      "role": "admin"
    }
  ]
}

400

Invalid tenant name

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Missing or invalid authentication

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Not a member of this tenant

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Rate limit exceeded

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}