Account Invitations
List account invitations
Account Invitations
List account invitations
List all account invitations
GET
/
account-invitations
X-API-KEY
string
*
X-API-KEY
Required
string
limit
integer
limit
integer
Number of resources to return
offset
integer
offset
integer
Number of resources to skip
sort
string
sort
string
Field to sort by
order
enum<string>
order
enum<string>
Sort order
curl --request GET \
--url https://cookiechimp.com/api/v1/account-invitations \
--header 'X-API-KEY: <api-key>'
{
"data": [
{
"id": "inv123",
"email": "[email protected]",
"role": "member",
"invited_by_type": "API",
"created_at": "2023-01-25T09:30:20Z",
"updated_at": "2023-01-25T09:30:20Z"
}
],
"pagination": {
"total": 100,
"limit": 20,
"offset": 0
}
}
Authorizations
X-API-KEY
string
headerrequiredQuery Parameters
limit
integer
default: 20Number of resources to return
offset
integer
default: 0Number of resources to skip
sort
string
Field to sort by
order
enum<string>
Sort order
Available options:
asc
, desc
Response
200 - application/json
data
object[]
data.name
string
requiredName of the user the invitation is for
data.email
string
requiredEmail address of the user
data.role
enum<string>
requiredRole of the user when they accept the invitation
Available options:
admin
, member
data.id
string
data.invited_by_type
string
Type of entity that created the invitation (account_user or API)
data.invited_by_id
string | null
ID of the user who created the invitation
data.created_at
string
Date and time when the invitation was created
data.updated_at
string
Date and time when the invitation was last updated
data.deleted_at
string
Date and time when the invitation was cancelled
pagination
object
pagination.total
integer
Total number of resources
pagination.limit
integer
Number of resources to return
pagination.offset
integer
Number of resources to skip
curl --request GET \
--url https://cookiechimp.com/api/v1/account-invitations \
--header 'X-API-KEY: <api-key>'
{
"data": [
{
"id": "inv123",
"email": "[email protected]",
"role": "member",
"invited_by_type": "API",
"created_at": "2023-01-25T09:30:20Z",
"updated_at": "2023-01-25T09:30:20Z"
}
],
"pagination": {
"total": 100,
"limit": 20,
"offset": 0
}
}