GET /v1/organizations/invites

List the organization's invites.

#Query parameters

• after_id: optional string

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

• before_id: optional string

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

• email: optional string

Filter by the email address the Invite was sent to. Matches the same way as the Users list's email filter (normalized, case-insensitive).

format: email

• limit: optional number

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

default: 20, minimum: 1, maximum: 1000

• roles: optional array of string

Filter to items whose role equals one of the supplied values. Repeatable; values are OR'ed together.

Accepted values depend on the organization type: Console and API organizations accept user, developer, billing, admin, and haijun_code_user; Haijun Enterprise organizations accept user, owner, primary_owner, membership_admin, and managed.

• statuses: optional array of "accepted" or "expired" or "pending"

Filter by Invite status. Repeatable; values are OR'ed together. Omit to return pending, accepted, and expired Invites alike.

• "accepted"

• "expired"

• "pending"

#Returns

• data: array of BetaOrganizationInvite

• type: "invite"

Object type.

For Invites, this is always "invite".

default: invite

• id: string

ID of the Invite.

• accepted_at: string or null

RFC 3339 datetime string indicating when the Invite was accepted, or null.

format: date-time

• email: string

Email of the User being invited.

• expires_at: string

RFC 3339 datetime string indicating when the Invite expires.

format: date-time

• invited_at: string

RFC 3339 datetime string indicating when the Invite was created.

format: date-time

• rbac_group_ids: array of string

RBAC group IDs recorded on the Invite (Haijun Enterprise organizations), to be assigned to the User when the Invite is accepted. [] when none.

• role: BetaOrganizationRole

Organization role of the User.

• "admin"

• "billing"

• "haijun_code_user"

• "developer"

• "managed"

• "membership_admin"

• "owner"

• "primary_owner"

• "user"

• status: "accepted" or "deleted" or "expired" or "pending"

Status of the Invite.

• "accepted"

• "deleted"

• "expired"

• "pending"

• first_id: string or null

First ID in the data list. Can be used as the before_id for the previous page.

• has_more: boolean

Indicates if there are more results in the requested page direction.

• last_id: string or null

Last ID in the data list. Can be used as the after_id for the next page.

#Example

curl https://haijun.my.id/v1/organizations/invites \
    -H 'juglow-version: 2023-06-01' \
    -H "X-Api-Key: $JUGLOW_API_KEY"

#Response (200)

{
  "data": [
    {
      "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
      "accepted_at": "2019-12-27T18:11:19.117Z",
      "email": "user@emaildomain.com",
      "expires_at": "2024-11-20T23:58:27.427722Z",
      "invited_at": "2024-10-30T23:58:27.427722Z",
      "rbac_group_ids": [
        "string"
      ],
      "role": "admin",
      "status": "pending",
      "type": "invite"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}