curl --request GET \
--url https://apix.us.amity.co/api/v1/invitations/me \
--header 'Authorization: Bearer <token>'
{
"invitations": [
{
"_id": "<string>",
"networkId": "<string>",
"type": "communityMemberInvite",
"targetId": "<string>",
"targetType": "community",
"userId": "<string>",
"status": "pending",
"createdBy": "<string>",
"respondedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"invitationId": "<string>",
"invitedUserId": "<string>",
"invitedUserPublicId": "<string>",
"invitedUserInternalId": "<string>",
"inviterUserId": "<string>",
"inviterUserPublicId": "<string>",
"inviterUserInternalId": "<string>",
"communityId": "<string>"
}
],
"users": [
{
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [
"MUTE_CHANNEL"
],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isDeleted": true
}
],
"paging": {
"next": "<string>",
"previous": "<string>"
}
}
Retrieves a paginated list of invitations for the authenticated user. This endpoint returns invitations where the authenticated user is the invitee.
curl --request GET \
--url https://apix.us.amity.co/api/v1/invitations/me \
--header 'Authorization: Bearer <token>'
{
"invitations": [
{
"_id": "<string>",
"networkId": "<string>",
"type": "communityMemberInvite",
"targetId": "<string>",
"targetType": "community",
"userId": "<string>",
"status": "pending",
"createdBy": "<string>",
"respondedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"invitationId": "<string>",
"invitedUserId": "<string>",
"invitedUserPublicId": "<string>",
"invitedUserInternalId": "<string>",
"inviterUserId": "<string>",
"inviterUserPublicId": "<string>",
"inviterUserInternalId": "<string>",
"communityId": "<string>"
}
],
"users": [
{
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [
"MUTE_CHANNEL"
],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isDeleted": true
}
],
"paging": {
"next": "<string>",
"previous": "<string>"
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Filter invitations by type (optional)
communityMemberInvite
Filter by target entity type (optional)
community
Filter by specific target entity ID (optional)
900
Pagination after cursor
24
Pagination before cursor
24
Number of results per page (positive integer)
x >= 1
Pagination token
1000
List of invitations
The response is of type object
.