v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_User

List user invites

Returns all pending user invitations for the specified tenant, including each invite's status, metadata, and assigned role.

Use this endpoint to audit outstanding invitations, detect stale or duplicate invites, or build an admin UI that surfaces which users have been invited but have not yet completed registration.

About List User Invites

When a user is invited via POST /authn2/v0/tenant/{enterprise_id}/invite, an invite record is created and persists until the user accepts it or it is explicitly deleted. This endpoint returns the full list of those records for the tenant, including the role and group assignments encoded in the meta field, the associated identity provider invite ID (idp_invite_id), and timestamps. The response structure wraps results in a userinvites array alongside a count field.

Key Fields (Response)

id — the Esper invite UUID; use this with the DELETE endpoint to cancel an invite

email — the email address the invite was sent to

meta — the role and group assignment payload set at invite creation time, including any custom RBAC role binding

idp_invite_id — the identity provider's reference ID for this invite

send_invitation_email — whether an email was triggered for this invite

created_at / updated_at — timestamps for tracking invite age

Common Use Cases

Auditing which users have pending (unaccepted) invitations

Identifying and cleaning up stale invites before re-inviting a user

Building an admin console view of the invite queue

Best Practices

Cross-reference email values against your user directory to identify invites sent to addresses that have since changed

Use created_at to flag invites that have been pending longer than your organization's acceptable window, then cancel and re-invite as needed

Check this endpoint before calling POST .../invite to avoid duplicate invitations to the same email

Workflow

Call GET /authn2/v0/tenant/{enterprise_id}/invite to retrieve all pending invites

Review the userinvites array for emails, roles, and invite age

For any stale or incorrect invites, note the id and call DELETE /authn2/v0/tenant/{enterprise_id}/invite/{invite_id} to cancel

get/authn2/v0/tenant/{enterprise_id}/invite

Path parameters

enterprise_idstring uuid required

Enterprise ID

Response

Tenant user invites

countinteger