Skip to content
Product Docs

Accept Invite

client.invites.accept(stringinviteID, RequestOptionsoptions?): InviteAcceptResponse { organization_id }
POST/api/v2/invites/{invite_id}/accept

Accept a pending invitation. Returns the joined organization id.

ParametersExpand Collapse
inviteID: string
ReturnsExpand Collapse
InviteAcceptResponse { organization_id }

Response for accepting an invitation.

organization_id: string

The organization the user just joined.

Accept Invite

import LlamaCloudAdmin from '@llamaindex/llama-cloud-admin';

const client = new LlamaCloudAdmin({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.invites.accept('invite_id');

console.log(response.organization_id);
{
  "organization_id": "organization_id"
}
Returns Examples
{
  "organization_id": "organization_id"
}