Skip to content

Team API ​

Use the Team API to inspect workspace members, invite members, and update access.

Team member object ​

FieldTypeDescription
idstringUser ID with the usr_ prefix.
namestringMember name.
emailstringMember email.
rolestringowner, manager, or staff.
statusstringinvited, active, or suspended.
created_atstringISO 8601 timestamp.

List members ​

http
GET /team

Invite a member ​

http
POST /team/invitations

Required: email, role.

json
{
  "email": "manager@example.com",
  "role": "manager"
}

201 Created

json
{
  "data": {
    "id": "invitation_13fe8a",
    "email": "manager@example.com",
    "role": "manager",
    "status": "pending",
    "expires_at": "2026-09-16T09:00:00Z"
  }
}

Update a member ​

http
PATCH /team/{user_id}

Supported operations include changing a role, suspending a member, or reactivating a member.

Owner-only operations return 403 permission_denied for other roles.

Cedius is an illustrative API documentation portfolio project.