Skip to content
Qualia Docs

List Invitations

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

The pending invitations to one workspace, or with no project_id every one in the organization, each naming its space. Needs members:read, and a creator who manages 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 ”

The pending invitations

Media type application/json
InvitationList
object
invitations
required
Array<object>
Invitation

A pending invitation.

object
invitation_id
required
string format: uuid
email
required
string
space_id

The space it grants a role on

string | null format: uuid
space_role

The role it grants there

string
nullable
Allowed values: viewer contributor admin owner
space_name
string | null
space_kind
string
nullable
Allowed values: organization workspace
invited_by
string | null format: uuid
created_at
string | null format: date-time
expires_at
string | null format: date-time
Example 
{
  "invitations": [
    {
      "space_role": "viewer",
      "space_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": {}
    }
  ]
}