Organization Invites

List organization invites

get
/memberships/orgs/{organisationId}/invites

Gets the list of all invites for the specified organization

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
Query parameters
pageinteger · min: 1Optional

Page number for pagination

Default: 1Example: 1
limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20Example: 20
statusstring · enumOptional

Filter by invite status

Example: pendingPossible values:
typestring · enumOptional

Filter by invite type

Example: memberPossible values:
Responses
200

List of invites retrieved successfully

application/json
get
/memberships/orgs/{organisationId}/invites

Create an invitation

post
/memberships/orgs/{organisationId}/invites

Creates a new invitation to the organization, collective, or team

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
Body
typestring · enumRequired

Type of invitation

Example: memberPossible values:
channelstring · enumRequired

Communication channel for the invitation

Example: emailPossible values:
detailsobjectRequired

Detailed information about the invitation based on type

customMessagestring · max: 500Optional

Custom message to include in the invitation

Example: Welcome to our team!
expiresAtstring · date-timeOptional

When the invitation expires (defaults to 30 days)

Example: 2024-02-15T10:30:00Z
Responses
post
/memberships/orgs/{organisationId}/invites

Get invite information

get
/memberships/orgs/{organisationId}/invites/{inviteId}

Gets the information of a specific invite

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
inviteIdstring · uuidRequired

Unique ID of the invite

Example: invite123-def6-7890-abcd-ef1234567890
Responses
200

Invite information retrieved successfully

application/json
get
/memberships/orgs/{organisationId}/invites/{inviteId}

Update invite information

put
/memberships/orgs/{organisationId}/invites/{inviteId}

Updates the information of a specific invite (only pending invites)

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
inviteIdstring · uuidRequired

Unique ID of the invite

Example: invite123-def6-7890-abcd-ef1234567890
Body
customMessagestring · max: 500Optional

Updated custom message

Example: Updated invitation message
expiresAtstring · date-timeOptional

Updated expiration date

Example: 2024-03-15T10:30:00Z
Responses
200

Invite updated successfully

application/json
put
/memberships/orgs/{organisationId}/invites/{inviteId}

Cancel an invite

delete
/memberships/orgs/{organisationId}/invites/{inviteId}

Cancels a specific invite (only pending invites)

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
inviteIdstring · uuidRequired

Unique ID of the invite to cancel

Example: invite123-def6-7890-abcd-ef1234567890
Responses
200

Invite cancelled successfully

application/json
delete
/memberships/orgs/{organisationId}/invites/{inviteId}

Last updated