Skip to main content
GET
/
api
/
v1
/
invitations
/
count
Count invitations
curl --request GET \
  --url https://apix.us.amity.co/api/v1/invitations/count \
  --header 'Authorization: Bearer <token>'
{
  "count": 5
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
targetId
string
required

Filter by specific target entity ID

Maximum string length: 900
​
targetType
enum<string>
required

Filter by target entity type

Available options:
community,
room
​
type
enum<string>
required

Filter invitations by type

Available options:
communityMemberInvite,
livestreamCohostInvite
​
statuses
enum<string>[]

Filter invitations by status (array, optional)

Available options:
pending,
approved,
rejected,
cancelled

Response

Count invitations response

​
count
integer

Total number of invitations matching the criteria

Example:

5