Skip to content
Hayonix

API reference · Invitations

List invitations

GET/v1/orgs/{org_id}/invitations
Console sessionmember:readOrganizationPaginated

Returns the invitations the organization has sent, newest first, in every state unless you filter by status.

Console session only: no API key can be granted the member:read permission it needs. Requires the member:read permission (a key's scope, or a role that includes it).

Request

Path parameters

  • org_idstring

    Your organization. The SDKs and the CLI fill it in from the API key.

    ID with prefix org_

Query parameters

  • limitinteger

    1–200, default 50

    1–200

  • cursorstring

    `next_cursor` of the previous page

    up to 200 characters

  • statusstring

    Only invitations in this state

    One ofpendingacceptedrejectedcanceled

Response

200 a page of results — A page of invitations, newest first

  • The items of this page.

    Show 10 fields of data
    • objectstringrequired

      Always `invitation`: the type of this object

      One ofinvitation

    • idstringrequired

      Unique ID (`inv_…`)

      ID with prefix inv_

    • org_idstringrequired

      Organization it belongs to

      ID with prefix org_

    • emailstringrequired

      Email address the invitation was sent to

    • rolestring | nullrequired

      Role the invitee gets on accepting; null when none was recorded

      One ofowneradmindeveloperbillingviewer

    • statusstringrequired

      `pending` (can still be accepted until `expires_at`), `accepted`, `rejected` or `canceled`

    • expires_atstring (date-time)required

      When it expires (null: never) (ISO 8601, UTC)

    • inviter_user_idstringrequired

      ID of the inviter user

    • inviterobject | nullrequired

      Who sent the invitation

      Show 3 fields of inviter
      • objectstringrequired

        Always `person`

        One ofperson

      • idstringrequired

        The person’s user ID (`usr_…`)

      • namestring | nullrequired

        Their name as they set it; null when they are no longer a member of the organization

    • created_atstring (date-time)required

      When it was created (ISO 8601, UTC)

  • next_cursorstring | nullrequired

    Pass as `cursor` for the next page; null on the last page.

Example response
Example response
{
  "data": [
    {
      "object": "invitation",
      "id": "inv_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "email": "string",
      "role": "owner",
      "status": "pending",
      "expires_at": "2026-01-01T00:00:00.000Z",
      "inviter_user_id": "string",
      "inviter": {
        "object": "person",
        "id": "string",
        "name": "string"
      },
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.