Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the event
curl --request GET \
--url https://apix.us.amity.co/api/v1/events/{eventId} \
--header 'Authorization: Bearer <token>'{
"events": [
{
"eventId": "<string>",
"userId": "<string>",
"title": "<string>",
"description": "<string>",
"type": "virtual",
"status": "scheduled",
"isInviteOnly": true,
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"location": "<string>",
"externalUrl": "<string>",
"coverImageFileId": "<string>",
"originId": "<string>",
"originType": "community",
"livestreamId": "<string>",
"discussionCommunityId": "<string>",
"isLocationVisible": true,
"isOriginPublic": true,
"rsvpCount": 123,
"interestedCount": 123,
"tags": [
"<string>"
],
"metadata": {},
"isDeleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"eventResponses": [
{
"eventId": "<string>",
"userId": "<string>",
"status": "going",
"respondedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"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
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"type": "image",
"accessType": "public",
"altText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attributes": {
"name": "<string>",
"extension": "<string>",
"size": 123,
"mimeType": "<string>",
"metadata": {
"exif": {},
"gps": {},
"height": 123,
"width": 123,
"isFull": true
}
}
}
],
"communities": [
{
"_id": "<string>",
"path": "<string>",
"communityId": "<string>",
"channelId": "<string>",
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"displayName": "<string>",
"avatarFileId": "<string>",
"description": "<string>",
"isOfficial": true,
"isPublic": true,
"onlyAdminCanPost": true,
"tags": [
"<string>"
],
"metadata": {},
"postsCount": 123,
"membersCount": 123,
"isJoined": true,
"categoryIds": [
"<string>"
],
"isDeleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"hasFlaggedComment": false,
"hasFlaggedPost": false,
"needApprovalOnPostCreation": false,
"moderatorMemberCount": 123,
"allowCommentInStory": true,
"isDiscoverable": false,
"requiresJoinApproval": false,
"notificationMode": "default"
}
],
"discussionCommunities": [
{
"_id": "<string>",
"path": "<string>",
"communityId": "<string>",
"channelId": "<string>",
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"displayName": "<string>",
"avatarFileId": "<string>",
"description": "<string>",
"isOfficial": true,
"isPublic": true,
"onlyAdminCanPost": true,
"tags": [
"<string>"
],
"metadata": {},
"postsCount": 123,
"membersCount": 123,
"isJoined": true,
"categoryIds": [
"<string>"
],
"isDeleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"hasFlaggedComment": false,
"hasFlaggedPost": false,
"needApprovalOnPostCreation": false,
"moderatorMemberCount": 123,
"allowCommentInStory": true,
"isDiscoverable": false,
"requiresJoinApproval": false,
"notificationMode": "default"
}
],
"videoStreamings": [
{
"streamId": "<string>",
"userId": "<string>",
"userInternalId": "64be1f6cb9b4106b5a6bbf3f",
"userPublicId": "User123",
"thumbnailFileId": "<string>",
"title": "<string>",
"status": "idle",
"isLive": true,
"isDeleted": true,
"description": "<string>",
"platform": {
"name": "<string>",
"version": "<string>"
},
"moderationId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {},
"resolution": "SD",
"streamerUrl": {
"url": "<string>",
"components": {
"origin": "<string>",
"appName": "<string>",
"streamName": "<string>",
"query": "<string>"
}
},
"recordings": [
{
"flv": {
"url": "<string>",
"duration": 123,
"startTime": 123,
"stopTime": 123
},
"mp4": {
"url": "<string>",
"duration": 123,
"startTime": 123,
"stopTime": 123
},
"m3u8": {
"url": "<string>",
"duration": 123,
"startTime": 123,
"stopTime": 123
}
}
],
"watcherUrl": {
"flv": {
"url": "<string>",
"components": {
"origin": "<string>",
"appName": "<string>",
"streamName": "<string>",
"query": "<string>"
}
},
"hls": {
"url": "<string>",
"components": {
"origin": "<string>",
"appName": "<string>",
"streamName": "<string>",
"query": "<string>"
}
},
"rtmp": {
"url": "<string>",
"components": {
"origin": "<string>",
"appName": "<string>",
"streamName": "<string>",
"query": "<string>"
}
}
},
"postId": "<string>",
"channelId": "<string>",
"channelEnabled": true,
"isParent": false,
"parentStreamId": "<string>",
"childStreamIds": []
}
]
}Get event details by ID.
Access Control:
curl --request GET \
--url https://apix.us.amity.co/api/v1/events/{eventId} \
--header 'Authorization: Bearer <token>'{
"events": [
{
"eventId": "<string>",
"userId": "<string>",
"title": "<string>",
"description": "<string>",
"type": "virtual",
"status": "scheduled",
"isInviteOnly": true,
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"location": "<string>",
"externalUrl": "<string>",
"coverImageFileId": "<string>",
"originId": "<string>",
"originType": "community",
"livestreamId": "<string>",
"discussionCommunityId": "<string>",
"isLocationVisible": true,
"isOriginPublic": true,
"rsvpCount": 123,
"interestedCount": 123,
"tags": [
"<string>"
],
"metadata": {},
"isDeleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"eventResponses": [
{
"eventId": "<string>",
"userId": "<string>",
"status": "going",
"respondedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"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
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"type": "image",
"accessType": "public",
"altText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attributes": {
"name": "<string>",
"extension": "<string>",
"size": 123,
"mimeType": "<string>",
"metadata": {
"exif": {},
"gps": {},
"height": 123,
"width": 123,
"isFull": true
}
}
}
],
"communities": [
{
"_id": "<string>",
"path": "<string>",
"communityId": "<string>",
"channelId": "<string>",
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"displayName": "<string>",
"avatarFileId": "<string>",
"description": "<string>",
"isOfficial": true,
"isPublic": true,
"onlyAdminCanPost": true,
"tags": [
"<string>"
],
"metadata": {},
"postsCount": 123,
"membersCount": 123,
"isJoined": true,
"categoryIds": [
"<string>"
],
"isDeleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"hasFlaggedComment": false,
"hasFlaggedPost": false,
"needApprovalOnPostCreation": false,
"moderatorMemberCount": 123,
"allowCommentInStory": true,
"isDiscoverable": false,
"requiresJoinApproval": false,
"notificationMode": "default"
}
],
"discussionCommunities": [
{
"_id": "<string>",
"path": "<string>",
"communityId": "<string>",
"channelId": "<string>",
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"displayName": "<string>",
"avatarFileId": "<string>",
"description": "<string>",
"isOfficial": true,
"isPublic": true,
"onlyAdminCanPost": true,
"tags": [
"<string>"
],
"metadata": {},
"postsCount": 123,
"membersCount": 123,
"isJoined": true,
"categoryIds": [
"<string>"
],
"isDeleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"hasFlaggedComment": false,
"hasFlaggedPost": false,
"needApprovalOnPostCreation": false,
"moderatorMemberCount": 123,
"allowCommentInStory": true,
"isDiscoverable": false,
"requiresJoinApproval": false,
"notificationMode": "default"
}
],
"videoStreamings": [
{
"streamId": "<string>",
"userId": "<string>",
"userInternalId": "64be1f6cb9b4106b5a6bbf3f",
"userPublicId": "User123",
"thumbnailFileId": "<string>",
"title": "<string>",
"status": "idle",
"isLive": true,
"isDeleted": true,
"description": "<string>",
"platform": {
"name": "<string>",
"version": "<string>"
},
"moderationId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {},
"resolution": "SD",
"streamerUrl": {
"url": "<string>",
"components": {
"origin": "<string>",
"appName": "<string>",
"streamName": "<string>",
"query": "<string>"
}
},
"recordings": [
{
"flv": {
"url": "<string>",
"duration": 123,
"startTime": 123,
"stopTime": 123
},
"mp4": {
"url": "<string>",
"duration": 123,
"startTime": 123,
"stopTime": 123
},
"m3u8": {
"url": "<string>",
"duration": 123,
"startTime": 123,
"stopTime": 123
}
}
],
"watcherUrl": {
"flv": {
"url": "<string>",
"components": {
"origin": "<string>",
"appName": "<string>",
"streamName": "<string>",
"query": "<string>"
}
},
"hls": {
"url": "<string>",
"components": {
"origin": "<string>",
"appName": "<string>",
"streamName": "<string>",
"query": "<string>"
}
},
"rtmp": {
"url": "<string>",
"components": {
"origin": "<string>",
"appName": "<string>",
"streamName": "<string>",
"query": "<string>"
}
}
},
"postId": "<string>",
"channelId": "<string>",
"channelEnabled": true,
"isParent": false,
"parentStreamId": "<string>",
"childStreamIds": []
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ID of the event
Event details retrieved successfully
Show child attributes
Current user's RSVP for this event (if exists)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes