Get invitations

curl --request GET \
  --url https://apix.us.amity.co/api/v1/invitations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v1/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v1/invitations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.us.amity.co/api/v1/invitations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v1/invitations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "invitations": [
    {
      "_id": "<string>",
      "networkId": "<string>",
      "type": "communityMemberInvite",
      "targetId": "<string>",
      "targetType": "community",
      "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>"
  }
}

{
  "status": "error",
  "code": 400300,
  "message": "Forbidden error."
}

{
  "status": "error",
  "code": 400400,
  "message": "Resource Not Found."
}

{
  "status": "error",
  "code": 500000,
  "message": "Parameters validation error!."
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

GET

api

invitations

Get invitations

curl --request GET \
  --url https://apix.us.amity.co/api/v1/invitations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v1/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v1/invitations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.us.amity.co/api/v1/invitations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v1/invitations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "invitations": [
    {
      "_id": "<string>",
      "networkId": "<string>",
      "type": "communityMemberInvite",
      "targetId": "<string>",
      "targetType": "community",
      "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>"
  }
}

{
  "status": "error",
  "code": 400300,
  "message": "Forbidden error."
}

{
  "status": "error",
  "code": 400400,
  "message": "Resource Not Found."
}

{
  "status": "error",
  "code": 500000,
  "message": "Parameters validation error!."
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

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

Show child attributes

users

object[]

User details for inviters and invitees

Show child attributes

paging

object

Show child attributes

Retrieve edit history for content Create invitations

⌘I