User Invites

Get an invite

GET/invites/{id}
invites:readget_inviteRead-only

Returns one invite. An unknown invite, one of another organisation, or an advisor invite when the caller is an advisor returns 404. Use GET /invites to list them. Sends nothing.

Path parameters

  • idstring (uuid)Required#

    The invite's id, a uuid. An unknown invite, or one outside the token's organisation, returns 404.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

Responses

200

The invite.

Invite
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "investor",
    "status": "invited",
    "email": "string",
    "title": "string",
    "first_name": "string",
    "last_name": "string",
    "sso_id": "string",
    "onboarding_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "user_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "expires_at": "2026-06-12T10:00:00+00:00",
    "invited_at": "2026-06-12T10:00:00+00:00",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/invites/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"