Skip to content

Get a join link

Get an active organization join link or create one that lasts seven days. Anyone who opens the link and signs in can join in its assigned role. The admin link requires the billing owner or an admin with no withheld commands.

Parameters

#
rolestring
Join-link role: user (default) or admin.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
A link granting membership in an organization.
Show 6 attributesHide attributes
created_atstring (date-time)Always present
When the link was created.
expires_atstring (date-time)Always present
When the link expires.
joinedintegerAlways present
Number of people who joined through this link.
organizationstringAlways present
Organization joined through the link.
rolestringAlways present
Organization role granted on joining: user or admin.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.