List user invitations
List all the invitations sent to current user.
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
Schema
- Array [
- ]
- Array [
- ]
invitations object[]
The unique invitation identifier.
The user email of the invited user.
The organization id to which the user is invited.
The list of group ids to which the user is invited.
The metadata of the invitation.
The time when the invitation was created.
The time when the invitation expires.
The list of role ids to which the user is invited in an organization.
orgs object[]
The time the organization was created.
The time the organization was last updated.
The state of the organization (enabled or disabled).
The base64 encoded image string of the organization avatar. Should be less than 2MB.
{
"invitations": [
{
"id": "k9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
"userId": "john.doe@raystack.org",
"orgId": "b9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
"groupIds": "c9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
"metadata": {
"key": "value"
},
"createdAt": "2023-06-07T05:39:56.961Z",
"expiresAt": "2023-06-07T05:39:56.961Z",
"roleIds": "d9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b"
}
],
"orgs": [
{
"id": "string",
"name": "string",
"title": "string",
"metadata": {},
"createdAt": "2023-06-07T05:39:56.961Z",
"updatedAt": "2023-06-07T05:39:56.961Z",
"state": "enabled",
"avatar": "string"
}
]
}
Bad Request - The request was malformed or contained invalid parameters.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}