Skip to content
Qualia Docs

List Members

GET
/v1/members
 
curl --request GET \
  --url https://example.com/v1/members \
  --header 'X-API-Key: <X-API-Key>'

Everyone with access to the organization, or to one workspace with project_id: their role there and each path that gives it.

Needs members:read (and projects:read, which reading any space takes). can_manage_members says whether this caller may change people there.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
project_id

A workspace of the organization; omit it for the organization itself. A workspace key names its own workspace.

string | null format: uuid

A workspace of the organization; omit it for the organization itself. A workspace key names its own workspace.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Everyone with access and their roles

Media type application/json
MemberList

Everyone with access to the organization or one workspace.

object
space
required
SpaceRef

Enough of a space to name it.

object
space_id
required
string format: uuid
kind
required
string
Allowed values: organization workspace
name
required
string
slug
string | null
icon

A workspace’s icon; null for none

string | null
people
required
Array<object>
Member

A person with access to the space, their role and where it comes from.

object
user_id
required
string format: uuid
email
string | null
display_name
string | null
role
required

Their effective role here

string
Allowed values: viewer contributor admin owner
paths
Array<object>
AccessPath

One reason a person holds a role on a space.

object
role
required
string
Allowed values: viewer contributor admin owner
source
required

Direct, inherited (from the organization), membership or inherited_membership

string
grant_id
required
string format: uuid
granted_on
required
SpaceRef

The space the grant sits on: this one or the organization

object
space_id
required
string format: uuid
kind
required
string
Allowed values: organization workspace
name
required
string
slug
string | null
icon

A workspace’s icon; null for none

string | null
via

The space whose membership carried the grant, if any

object
space_id
required
string format: uuid
kind
required
string
Allowed values: organization workspace
name
required
string
slug
string | null
icon

A workspace’s icon; null for none

string | null
can_manage_members

The caller may change people here: for a key, its creator’s role holds spaces:members and the key holds members:write

boolean
can_create_children

The caller may create, rename and delete workspaces

boolean
my_role

The caller’s role here: the most they may grant

string
nullable
Allowed values: viewer contributor admin owner
Example 
{
  "space": {
    "kind": "organization"
  },
  "people": [
    {
      "role": "viewer",
      "paths": [
        {
          "role": "viewer",
          "granted_on": {
            "kind": "organization"
          },
          "via": {
            "kind": "organization"
          }
        }
      ]
    }
  ],
  "can_manage_members": false,
  "can_create_children": false,
  "my_role": "viewer"
}

401

Section titled “401 ”

Invalid or missing API key

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
  "detail": "example"
}

403

Section titled “403 ”

The key lacks members:read, or its creator’s role does not allow it

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
  "detail": "example"
}

404

Section titled “404 ”

Not found or not readable

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
  "detail": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}