User Invites

Get an invite's timeline

GET/invites/{id}/history
invites:readget_invite_historyRead-only

Returns the invite's timeline, oldest first, built from its own dates: created, invited, completed or revoked, and expires. There is no separate audit log, so a resend moves the invited event rather than adding one. The whole timeline comes back at once, at most five events, and query parameters are ignored. An unknown invite, or one outside your organisation, returns 404. 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.

Responses

200

The timeline.

InviteHistoryEvent[]
{
  "data": [
    {
      "event": "created",
      "status": "draft",
      "occurred_at": "2026-06-15T10:30:00Z"
    },
    {
      "event": "invited",
      "status": "invited",
      "occurred_at": "2026-06-15T10:31:00Z"
    },
    {
      "event": "expires",
      "status": "invited",
      "occurred_at": "2026-07-15T10:31:00Z"
    }
  ]
}
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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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