List teams

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

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

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

	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/teams")

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

{
  "customerId": "<string>",
  "teamsEnabled": true,
  "teams": [
    {
      "id": "<string>",
      "customerId": "<string>",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "monthlyCreditLimit": 123,
      "capabilityAdminSettings": {
        "capabilities": {},
        "defaultMode": "<string>",
        "allowUserMcpServers": true,
        "defaultCreditDetails": true,
        "hideUnavailableCapabilities": true,
        "defaultContact": "<string>"
      },
      "documentWriteAccess": {
        "humanPolicy": "<string>",
        "agentPolicy": "<string>"
      },
      "notificationSettings": {},
      "members": [
        {
          "userId": "<string>",
          "name": "<string>",
          "email": "<string>",
          "role": "<string>"
        }
      ]
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

workspaceapi

teams

List teams

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

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

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

	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/teams")

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

{
  "customerId": "<string>",
  "teamsEnabled": true,
  "teams": [
    {
      "id": "<string>",
      "customerId": "<string>",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "monthlyCreditLimit": 123,
      "capabilityAdminSettings": {
        "capabilities": {},
        "defaultMode": "<string>",
        "allowUserMcpServers": true,
        "defaultCreditDetails": true,
        "hideUnavailableCapabilities": true,
        "defaultContact": "<string>"
      },
      "documentWriteAccess": {
        "humanPolicy": "<string>",
        "agentPolicy": "<string>"
      },
      "notificationSettings": {},
      "members": [
        {
          "userId": "<string>",
          "name": "<string>",
          "email": "<string>",
          "role": "<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.

Query Parameters

includeMembers

boolean

If true, include team members (with role) on each team. Defaults to false.

name

string

Only teams with exactly this name, ignoring case.

tag

string

Only teams with this tag.

Response

Success. Empty result sets are also 200.

All teams in the workspace. members is only present when includeMembers=true.

customerId

string

required

teamsEnabled

boolean

required

False when teams are off for the workspace; teams is then empty.

teams

object[]

required

Show child attributes