Skip to content
Qualia Docs

Get Member

GET
/v1/members/{user_id}
 
curl --request GET \
  --url https://example.com/v1/members/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

One person’s role on every space of the organization the caller reads, with where each comes from. Needs members:read and an organization key: a workspace key never reads across the organization.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
user_id
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The person’s access across the organization

Media type application/json
Person

One person’s access across the organization: every space the caller reads.

object
user_id
required
string format: uuid
email
string | null
display_name
string | null
username
string | null
member

A member of the organization; false for a guest

boolean
spaces
required
Array<object>
PersonSpace

One space of a person’s access across 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
parent_id
string | null format: uuid
role

Their effective role here

string
nullable
Allowed values: viewer contributor admin owner
source

Organization or workspace

string | null
direct

The role granted on this space itself, if any

string
nullable
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
Example 
{
  "member": false,
  "spaces": [
    {
      "kind": "organization",
      "role": "viewer",
      "direct": "viewer",
      "paths": [
        {
          "role": "viewer",
          "granted_on": {
            "kind": "organization"
          },
          "via": {
            "kind": "organization"
          }
        }
      ]
    }
  ]
}

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": {}
    }
  ]
}