Skip to content

List members

GET
/org/members
curl --request GET \
--url 'https://api.asklucy.eu/v1/org/members?limit=25&role=member' \
--header 'Authorization: Bearer <token>'

Everyone in the organization who can use Lucy. People arrive through the company’s identity provider (sign-in); removeMember deletes a leaver’s data and access.

cursor
string

The next_cursor of the previous page.

limit
integer
default: 25 >= 1 <= 100
q
string
<= 200 characters

Search in names and emails.

role
  • member: use Lucy (conversations, files, memory).
  • org_admin: also settings, members, usage, audit, and the organization’s memory (reviewing processes, forgetting shared facts).
  • auditor: read the audit log only.
string
Allowed values: member org_admin auditor

OK

Media typeapplication/json
object
data
required
Array<object>
object
user
required
object
id
required

Zitadel user ID.

string
name
required
string
email
string | null format: email
kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string
Allowed values: person service agent
roles
required
Array<string>
Allowed values: member org_admin auditor
status
required

Deactivated in the company’s identity provider.

string
Allowed values: active deactivated
last_active_at
string | null format: date-time
next_cursor
required
string | null

Example

{
"data": [
{
"user": {
"kind": "person"
},
"roles": [
"member"
],
"status": "active"
}
]
}

Missing, expired or invalid token.

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
quota

For quota-exceeded, the window that is used up.

object
window
required
string
Allowed values: five_hours week month
percent_used
required
number
<= 100
resets_at
required

Null for a rolling window that hasn’t started.

string | null format: date-time
limited_by
required

organization when the organization’s budget is closer to running out than the member’s own limit.

string
Allowed values: personal organization
request
One of:

A request as its member sees it, where they asked.

object
id
required
string
status
required
string
Allowed values: pending approved declined withdrawn
created_at
required
string format: date-time
decided_at
required
string | null format: date-time
note
required

What the admin who decided wrote back.

string | null
errors

Field-level problems (400 only).

Array<object>
object
field
required

JSON pointer into the request body.

string
message
required
string

Example

{
"type": "https://docs.asklucy.eu/errors/answer-in-progress",
"quota": {
"window": "five_hours",
"limited_by": "personal",
"request": {
"status": "pending"
}
}
}
X-Request-Id
string

Unique per request; quote it to support.

The token is valid but lacks the role this needs.

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
quota

For quota-exceeded, the window that is used up.

object
window
required
string
Allowed values: five_hours week month
percent_used
required
number
<= 100
resets_at
required

Null for a rolling window that hasn’t started.

string | null format: date-time
limited_by
required

organization when the organization’s budget is closer to running out than the member’s own limit.

string
Allowed values: personal organization
request
One of:

A request as its member sees it, where they asked.

object
id
required
string
status
required
string
Allowed values: pending approved declined withdrawn
created_at
required
string format: date-time
decided_at
required
string | null format: date-time
note
required

What the admin who decided wrote back.

string | null
errors

Field-level problems (400 only).

Array<object>
object
field
required

JSON pointer into the request body.

string
message
required
string

Example

{
"type": "https://docs.asklucy.eu/errors/answer-in-progress",
"quota": {
"window": "five_hours",
"limited_by": "personal",
"request": {
"status": "pending"
}
}
}
X-Request-Id
string

Unique per request; quote it to support.