List Account Invites
List the invitations issued for the active account — the admin-side view of everyone who has been invited to join. Use it to render a "pending invites" table and to find the invite uuid you need for revoking.
The active account is taken from your session/API key context. Requires the members:read permission.
Query parameters
pending string optional
Pass
pending=1 to return only invitations still awaiting a response. Omit (or any other value) to return invitations in every state.page int optional
1-based page number. Omit it to get every invitation in one response.
page_size int optional
Invitations per page when
page is sent. Default 15, capped at 200.Response (200 OK)
Returns an array of invitation objects under the invitations key (an empty array when there are none), with the paging fields:
page, page_size int
The page returned and the effective page size. Both
0 when page was not sent (the whole list).total int
Number of matching invitations across all pages.
Each invitation:
uuid string (uuid)
The invitation's public id.
account_uuid string (uuid)
The
uuid of the active account.invited_email string
Email the invite was addressed to.
invited_user_uuid string (uuid)?
The user who answered the invitation, once it was accepted or declined. Omitted while it is pending.
role_uuid string (uuid)
The
uuid of the role granted on acceptance.role_name string
Display name of that role, for convenience.
invited_by_user_uuid string (uuid)
The
uuid of the user who issued the invite.inviter_name string
Display name of the inviter.
account_name string?
The active account's name. Omitted when empty.
status string
One of
pending, accepted, declined, expired, revoked. A pending invitation past its expires_at is shown as expired (and left out of pending=1).expires_at datetime?
When the invitation lapses if not acted on. Omitted when unset.
created_at, updated_at datetime
RFC 3339 UTC timestamps.
Deprecated: until the sunset this response also carries the legacy integer id and *_id fields. Don't use them; read uuid and the *_uuid fields.
Errors
401 Unauthorized
Missing or invalid auth.
403 Forbidden
Your role lacks the
members:read permission on the active account.500
Database error loading invitations.
Request
curl "https://api.ngris.com/v1/account/invites?pending=1&page=1&page_size=15" \
-H "X-API-KEY: <your_api_key>"
Python
from ngris import Ngris
client = Ngris(api_key="<your_api_key>")
invites = client._get_raw("/account/invites", params={"pending": "1", "page": 1, "page_size": 15})
for inv in invites["invitations"]:
print(inv["invited_email"], inv["status"])
Response — 200 OK
{
"invitations": [
{
"uuid": "019a89b0-bb2b-76eb-8f22-cf9745345430",
"account_uuid": "019a68b9-1a79-7820-a884-41f554aba6bd",
"invited_email": "teammate@example.com",
"role_uuid": "019a9625-4dd4-7506-aa4b-97bbf9a69640",
"role_name": "Developer",
"invited_by_user_uuid": "019a52c2-ca1e-78ba-ab5c-50362cc29134",
"inviter_name": "alice",
"account_name": "Acme Robotics",
"status": "pending",
"expires_at": "2026-06-06T13:00:00Z",
"created_at": "2026-05-30T13:00:00Z",
"updated_at": "2026-05-30T13:00:00Z"
}
],
"page": 1,
"page_size": 15,
"total": 1
}
Was this helpful?