User Invites

List invites

GET/invites
invites:readlist_invitesRead-only

Lists the invites of the token's organisation, newest first, and returns one page. filter[q] searches the invitee's name and email, filter[status] takes invited, draft, completed or revoked, filter[type] takes investor, internal_user or advisor, and filter[invited_at] limits when the invitation was sent. A caller who is an advisor never sees advisor invites. Use GET /invites/{id} for one. Sends nothing.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

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

  • sortstring#

    Comma-separated fields to sort by: created_at or invited_at. Prefix a field with - for descending. Defaults to -created_at. The invite id is the final tiebreak.

  • filter[q]string#

    Invites whose invitee first name, last name or email contains this text, ignoring case.

  • filter[status]string#

    Only invites in this state: invited, draft, completed or revoked. Takes [in] and [not_in] with a comma-separated list.

    One of: invited, draft, completed, revoked
  • filter[type]string#

    Only invites for this kind of invitee: investor, internal_user or advisor. Takes [in] and [not_in] with a comma-separated list.

    One of: investor, internal_user, advisor
  • filter[invited_at]string (date-time)#

    Only invites sent in a range, written filter[invited_at][gte]=2026-10-01. Takes gt, gte, lt and lte. A draft that was never sent has no sent date and is left out.

Responses

200

One page of invites.

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"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
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
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\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"