Skip to content
Bottle

List members

GET
/members
curl --request GET \
  --url https://example.com/members \
  --cookie bottle.session_token=<bottle.session_token>

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Members

Media typeapplication/json
object
items
required
Array<object>
object
user
required
object
id
required
string
email
required
string format: email
firstName
required
string
lastName
required
string
name
required
string
emailVerified
required
boolean
twoFactorEnabled
required
boolean
twoFactorMethod
required
string | null
Allowed values: totp otp
image
required
string | null
role
required

Owner: billing, deleting the tenant, full control of members. admin: all operational work and may manage drivers and admins. driver: their own round only.

string
Allowed values: owner admin driver
joinedAt
required
string format: date-time
total
required
integer
Example
{
  "items": [
    {
      "user": {
        "id": "kZ8n2xQpR1vLmT4wY7bJc",
        "email": "joe.bloggs@example.com",
        "firstName": "Joe",
        "lastName": "Bloggs",
        "name": "Joe Bloggs",
        "twoFactorMethod": "totp"
      },
      "role": "owner"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or the role is not allowed to do this

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}