List Invitations
List the pending invitations for your Mimeeq account. Use this request to find invitationId values before cancelling invitations or to check whether an invitation is still pending.
Records include the email, name, role IDs, default language and invitation timestamp where available. The response is a single data array with no pagination parameters. Existing account users are read through Users.
Requires the invitations:read scope.
API key sent as a bearer token (mk_live_… / mk_test_…).
Successful response.
Invalid request data.
Missing or invalid API key.
The API key lacks the required scope (scope_denied), or the operation is not permitted for this account (operation_not_permitted).
The API key exceeded its request rate (rate_limit_exceeded) or its monthly quota (quota_exceeded). Both carry Retry-After; the RateLimit-* headers accompany rate_limit_exceeded only, since a spent quota says nothing about the bucket.
Internal server error.
GET /v1/invitations HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"invitationId": "text",
"email": "text",
"name": "text",
"roles": [
"text"
],
"defaultUserLang": "text",
"invitedAt": "text"
}
]
}Last updated
Was this helpful?