API Reference · Organization · Invitations
Create invitation
Mutation
createInvitationInvites someone to the organization and sends them an invitation email.
createInvitation(
organizationUUID: ID!
createInvitationSpec: InvitationSpec!
): Invitation!Arguments
Field
Type
Returns
Field
Type
Example
mutation CreateInvitation($organizationUUID: ID!, $createInvitationSpec: InvitationSpec!) {
createInvitation(organizationUUID: $organizationUUID, createInvitationSpec: $createInvitationSpec) {
id
email
validUntil
token
createdAt
updatedAt
role {
id
name
permissionRoles
}
organization {
id
name
}
}
}Example response
{
"data": {
"createInvitation": {
"id": "01JB3X7T9QK2M4N6P8R0S2T4V6",
"email": "jane@example.com",
"validUntil": "2026-01-01T12:00:00Z",
"token": "Example token",
"createdAt": "2026-01-01T12:00:00Z",
"updatedAt": "2026-01-01T12:00:00Z",
"role": {
"id": "01JB3X7T9QK2M4N6P8R0S2T4V6",
"name": "Example name",
"permissionRoles": [
"Example permissionRoles"
]
},
"organization": {
"id": "01JB3X7T9QK2M4N6P8R0S2T4V6",
"name": "Example name"
}
}
}
}