1KEY Developers
Guides

Members

Members

Members are the people in your organization. Each is an owner, admin or member. Owners and admins manage members in the portal. An API key acts with its creator's current role: an owner's or admin's key with the members:* scopes does the same, except that no key changes or removes an owner, or makes one. A key stops working when its creator leaves the organization.

Inviting someone

curl
curl -X POST https://api.1keyplatform.dev/v1/invitations \
  -H "Authorization: Bearer $ONEKEY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "role": "member"}'

1key emails the address a link that works for 7 days. Accepting it adds them to your organization, creating their account if they have none; they then log in with a link 1key emails to that address. role is admin or member, and defaults to member. Needs members:write.

GET /invitations lists the pending ones; DELETE /invitations/{id} revokes one, so its link stops working.

Your organization

GET /organization returns the organization the key belongs to and the role the key acts with. PATCH /organization with {"name": ...} renames it; it needs organization:write and an owner or admin key.

Listing and changing members

curl
curl https://api.1keyplatform.dev/v1/members \
  -H "Authorization: Bearer $ONEKEY_API_KEY"
json
{
  "data": [
    { "id": "4b0f…", "email": "[email protected]", "role": "owner", "joined_at": "2026-09-12T15:20:00Z" },
    { "id": "9c2e…", "email": "[email protected]", "role": "member", "joined_at": "2026-10-01T10:02:11Z" }
  ],
  "has_more": false
}

Owners' and admins' keys see everyone; a member's key sees only its creator, and GET /members/{id} of anyone else answers 404.

PATCH /members/{id} with {"role": "admin"} or {"role": "member"} changes a role; DELETE /members/{id} removes someone. Both need members:write, and both answer 403 forbidden for an owner.