List workspace invitations

curl --request GET \
  --url https://service.abundly.ai/workspaceapi/invites \
  --header 'Authorization: Bearer <token>'

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

fetch('https://service.abundly.ai/workspaceapi/invites', 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://service.abundly.ai/workspaceapi/invites",
  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://service.abundly.ai/workspaceapi/invites"

	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://service.abundly.ai/workspaceapi/invites")

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

{
  "invites": [
    {
      "id": "<string>",
      "type": "<string>",
      "email": "<string>",
      "customerId": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "expiresAt": "<string>",
      "customerName": "<string>",
      "customerRole": "<string>",
      "isExpired": true,
      "invitedByUserName": "<string>",
      "displayName": "<string>",
      "groups": [
        {
          "groupId": "<string>",
          "role": "<string>"
        }
      ],
      "agentAccess": {
        "agentId": "<string>",
        "level": "<string>"
      }
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

workspaceapi

invites

List workspace invitations

curl --request GET \
  --url https://service.abundly.ai/workspaceapi/invites \
  --header 'Authorization: Bearer <token>'

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

fetch('https://service.abundly.ai/workspaceapi/invites', 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://service.abundly.ai/workspaceapi/invites",
  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://service.abundly.ai/workspaceapi/invites"

	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://service.abundly.ai/workspaceapi/invites")

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

{
  "invites": [
    {
      "id": "<string>",
      "type": "<string>",
      "email": "<string>",
      "customerId": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "expiresAt": "<string>",
      "customerName": "<string>",
      "customerRole": "<string>",
      "isExpired": true,
      "invitedByUserName": "<string>",
      "displayName": "<string>",
      "groups": [
        {
          "groupId": "<string>",
          "role": "<string>"
        }
      ],
      "agentAccess": {
        "agentId": "<string>",
        "level": "<string>"
      }
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST, PUT, PATCH and DELETE endpoints the Workspace write API scope, and sending or revoking invitations (POST and DELETE /workspaceapi/invites) the Invite members scope. A key stops working when it expires or is disabled.

Response

Success. Empty result sets are also 200.

Pending and expired invitations, which doubles as a record of who was invited but never joined.

invites

object[]

required

Show child attributes