Skip to main content
GET
/
api
/
v1
/
invitations
Get invitations
curl --request GET \
  --url https://apix.us.amity.co/api/v1/invitations \
  --header 'Authorization: Bearer <token>'
{
  "invitations": [
    {
      "_id": "<string>",
      "networkId": "<string>",
      "targetId": "<string>",
      "userId": "<string>",
      "createdBy": "<string>",
      "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>",
      "respondedAt": "2023-11-07T05:31:56Z",
      "communityId": "<string>"
    }
  ],
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ],
  "paging": {
    "next": "<string>",
    "previous": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
type
enum<string>
required

Filter invitations by type

Available options:
communityMemberInvite,
livestreamCohostInvite
​
targetType
enum<string>
required

Filter by target entity type

Available options:
community,
room
​
targetId
string
required

Filter by specific target entity ID

Maximum string length: 900
​
options[after]
string

Pagination after cursor

Maximum string length: 24
​
options[before]
string

Pagination before cursor

Maximum string length: 24
​
options[limit]
integer
default:10

Number of results per page (positive integer)

Required range: x >= 1
​
options[token]
string

Pagination token

Maximum string length: 1000
​
statuses
enum<string>[]

Filter invitations by status (array, optional)

Available options:
pending,
approved,
rejected,
cancelled
​
sortBy
enum<string>
default:createdAt

Sort invitations by field (optional)

Available options:
_id,
createdAt,
respondedAt
​
sortOrder
enum<string>
default:desc

Sort order (optional)

Available options:
asc,
desc

Response

List of invitations

​
invitations
object[]

List of invitation objects

​
users
object[]

User details for inviters and invitees

​
paging
object