Skip to main content
GET
/
api
/
v4
/
communities
/
{communityId}
/
join
Query join requests
curl --request GET \
  --url https://apix.us.amity.co/api/v4/communities/{communityId}/join \
  --header 'Authorization: Bearer <token>'
{
  "joinRequests": [
    {
      "_id": "<string>",
      "networkId": "<string>",
      "targetId": "<string>",
      "targetType": "<string>",
      "type": "<string>",
      "userId": "<string>",
      "status": "<string>",
      "respondedAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "joinRequestId": "<string>",
      "requestorId": "<string>",
      "requestorPublicId": "<string>",
      "requestorInternalId": "<string>",
      "responderId": "<string>",
      "responderPublicId": "<string>",
      "responderInternalId": "<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
    }
  ],
  "files": [
    {
      "fileId": "<string>",
      "fileUrl": "<string>",
      "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
        }
      }
    }
  ],
  "roles": [
    {
      "roleId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "permissions": [
        "<string>"
      ],
      "isDeleted": false,
      "displayName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "paging": {
    "next": "eyJhZnRlciI6eyJfaWQiOnsicG9zdElkIjoiNjUxNjZlZTNlOTVlZTQ4YjkzZWVkMjQ1IiwidXNlcklkIjoiNjUxNjZlZTRlOTVlZTQzZjgzZWVkMjViIn0sIm5ldHdvcmtJZCI6IjYwNmYzN2EzYWU2MDFlZjM3NGViYWEwMSIsInJlYWNoZWRBdCI6IjIwMjMtMDktMjlUMDY6Mjk6NTQuOTQ4WiJ9fQ==",
    "previous": "eyJhZnRlciI6eyJfaWQiOnsicG9zdElkIjoiNjUxNjZlZTNlOTVlZTQ4YjkzZWVkMjQ1IiwidXNlcklkIjoiNjUxNjZlZTRlOTVlZTQzZjgzZWVkMjViIn0sIm5ldHdvcmtJZCI6IjYwNmYzN2EzYWU2MDFlZjM3NGViYWEwMSIsInJlYWNoZWRBdCI6IjIwMjMtMDktMjlUMDY6Mjk6NTQuOTQ4WiJ9fQ=="
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
communityId
string
required
Required string length: 1 - 900

Query Parameters

​
type
enum<string>
required
Available options:
communityJoinRequest
​
targetType
enum<string>
required
Available options:
community
​
statuses
enum<string>[]
Available options:
pending,
approved,
rejected,
cancelled
​
sortBy
enum<string>
default:_id
Available options:
_id,
respondedAt
​
sortOrder
enum<string>
default:asc
Available options:
asc,
desc
​
options[limit]
integer
default:10

Number of results per page (1-100)

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

Pagination token for getting next/previous pages

Maximum string length: 1000

Response

Query Join Request Response

​
joinRequests
object[]
​
users
object[]
​
files
object[]
​
roles
object[]
​
paging
object