Parameters
#organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
Returns
#dataobjectAlways present
Organization join links visible to administrators.
Show 1 attributeHide attributes
linksobject[] | nullAlways present
Join links and their roles, expiry and use counts.
Show 1 attributeHide attributes
itemsobject
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.
linkstringAlways present
Claimable URL. Anyone holding it can accept the invitation.
organizationstringAlways present
Organization joined through the link.
rolestringAlways present
Organization role granted on joining:
user or admin.Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- CLI:
heaven loginwithHEAVEN_API_KEYunset. MCP: Heaven sign-in. cURL:HEAVEN_SIGN_IN_KEYfrom approved device sign-in (POST /v1/auth/create). - A key limited to a command list cannot run this command.