query · Module: Accounts · Requires accounts:read
Arguments
Returns
InvitationList!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query Invitations($limit: Int) {
invitations(limit: $limit) {
data {
id
object
status
livemode
created
updated
account
email
role
expires_at
membership
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"invitations": {
"data": [
{
"id": "inv_1a2B3c",
"object": "invitation",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"email": "ops@example.com",
"role": "example",
"expires_at": 1791302400,
"membership": "example"
}
],
"has_more": true
}
}
}
List invitations
query Invitations($limit: Int) {
invitations(limit: $limit) {
data {
id
object
status
livemode
created
updated
account
email
role
expires_at
membership
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"invitations": {
"data": [
{
"id": "inv_1a2B3c",
"object": "invitation",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"email": "ops@example.com",
"role": "example",
"expires_at": 1791302400,
"membership": "example"
}
],
"has_more": true
}
}
}
query · Module: Accounts · Requires accounts:read
| Argument | Type | Description |
|---|---|---|
status | String | Filter by status. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
InvitationList!
| Field | Type |
|---|---|
data | [Invitation!]! |
has_more | Boolean |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Invitations($limit: Int) {
invitations(limit: $limit) {
data {
id
object
status
livemode
created
updated
account
email
role
expires_at
membership
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"invitations": {
"data": [
{
"id": "inv_1a2B3c",
"object": "invitation",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"email": "ops@example.com",
"role": "example",
"expires_at": 1791302400,
"membership": "example"
}
],
"has_more": true
}
}
}