Skip to main content

​
List Organization Members

​
GET /organizations/me/members

Returns a paginated list of members in the currently active organization.

​
Authentication

Requires organization membership.

​
Query Parameters

​
limit
integer
default:"50"
Number of members to return per page
​
offset
integer
default:"0"
Number of members to skip for pagination

​
Response

Returns a paginated response containing organization members.
​
items
array
required
Array of organization member objects
​
total
integer
required
Total number of members in the organization
​
limit
integer
required
Number of items per page
​
offset
integer
required
Current pagination offset

​
Member Object Fields

​
id
string (UUID)
required
Unique identifier for the membership record
​
organization_id
string (UUID)
required
ID of the organization
​
user_id
string (UUID)
required
ID of the user
​
role
string
required
Member’s role: owner, admin, or member
​
all_boards_read
boolean
required
Whether member has read access to all boards by default
​
all_boards_write
boolean
required
Whether member has write access to all boards by default
​
created_at
string (datetime)
required
ISO 8601 timestamp when membership was created
​
updated_at
string (datetime)
required
ISO 8601 timestamp when membership was last updated
​
user
object
Embedded user information including id, email, name, and preferred_name
​
board_access
array
Array of board-specific access overrides

​
Example Request

curl -X GET "https://api.openclaw.com/organizations/me/members?limit=20&offset=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Example Response

{
  "items": [
    {
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "880e8400-e29b-41d4-a716-446655440000",
      "role": "owner",
      "all_boards_read": true,
      "all_boards_write": true,
      "created_at": "2026-03-01T10:00:00.000Z",
      "updated_at": "2026-03-01T10:00:00.000Z",
      "user": {
        "id": "880e8400-e29b-41d4-a716-446655440000",
        "email": "[email protected]",
        "name": "Jane Doe",
        "preferred_name": "Jane"
      },
      "board_access": []
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

​
Get Organization Member

​
GET /organizations/me/members/

Retrieve details about a specific organization member.

​
Authentication

Requires organization membership. Non-admin members can only view their own membership details.

​
Path Parameters

​
member_id
string (UUID)
required
ID of the organization member to retrieve

​
Response

Returns a member object (same structure as list endpoint) including board access overrides.

​
Error Responses

​
403 Forbidden
Non-admin users attempting to view other members’ details
​
404 Not Found
Member not found or does not belong to the organization

​
Update Organization Member

​
PATCH /organizations/me/members/

Update a member’s role in the organization. Requires admin privileges.

​
Authentication

Requires organization admin or owner privileges.

​
Path Parameters

​
member_id
string (UUID)
required
ID of the organization member to update

​
Request Body

​
role
string
New role for the member: owner, admin, or member

​
Example Request

curl -X PATCH "https://api.openclaw.com/organizations/me/members/770e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "admin"
  }'

​
Update Member Board Access

​
PUT /organizations/me/members//access

Update board-level access permissions for a member. Requires admin privileges.

​
Authentication

Requires organization admin or owner privileges.

​
Path Parameters

​
member_id
string (UUID)
required
ID of the organization member to update

​
Request Body

​
all_boards_read
boolean
default:"false"
Grant read access to all boards
​
all_boards_write
boolean
default:"false"
Grant write access to all boards
​
board_access
array
default:"[]"
Array of board-specific access overrides

​
Board Access Specification

​
board_access[].board_id
string (UUID)
required
ID of the board
​
board_access[].can_read
boolean
default:"true"
Read permission for this specific board
​
board_access[].can_write
boolean
default:"false"
Write permission for this specific board

​
Example Request

curl -X PUT "https://api.openclaw.com/organizations/me/members/770e8400-e29b-41d4-a716-446655440000/access" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "all_boards_read": false,
    "all_boards_write": false,
    "board_access": [
      {
        "board_id": "990e8400-e29b-41d4-a716-446655440000",
        "can_read": true,
        "can_write": true
      }
    ]
  }'

​
Error Responses

​
422 Unprocessable Content
One or more board IDs do not belong to the organization

​
Remove Organization Member

​
DELETE /organizations/me/members/

Remove a member from the organization. Requires admin privileges.

​
Authentication

Requires organization admin or owner privileges.

​
Path Parameters

​
member_id
string (UUID)
required
ID of the organization member to remove

​
Response

Returns a success confirmation. 
{
  "ok": true
}

​
Example Request

curl -X DELETE "https://api.openclaw.com/organizations/me/members/770e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Error Responses

​
403 Forbidden
  • Attempting to remove yourself
  • Non-owners attempting to remove owners
​
404 Not Found
Member not found or does not belong to the organization
​
422 Unprocessable Content
Attempting to remove the last owner from the organization

​
Notes

  • Members cannot remove themselves from organizations
  • Only owners can remove other owners
  • Organizations must have at least one owner at all times
  • When a member is removed, their board access records are also deleted
  • If the removed user had this organization as their active organization, it will automatically switch to another membership or null

Build docs developers (and LLMs) love

Get started for freeTalk to us