Check invite eligibility

View as Markdown

Checks whether potential invitees meet the organization’s compliance requirements. Returns per-email warnings (not hard blocks). Requires org membership with members:read permission.

Authentication

AuthorizationBearer

JWT access token from POST /auth/login or POST /oauth/token

OR
x-api-keystring

Organization-scoped API key created via POST /orgs/:orgId/api-keys. Carries permission grants.

Path parameters

orgIdstringRequired

Request

This endpoint expects an object.
emailslist of stringsRequired

Email addresses to check eligibility for (max 50)

Response

Response
warningslist of objects
orgRequirementsobject

Errors

403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error