Get team members - Ribbon API Documentation

GET

team-members

Get team members

curl --request GET \
  --url https://app.ribbon.ai/be-api/v1/team-members \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.ribbon.ai/be-api/v1/team-members', 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://app.ribbon.ai/be-api/v1/team-members",
  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://app.ribbon.ai/be-api/v1/team-members"

	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://app.ribbon.ai/be-api/v1/team-members")

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

{
  "team_members": [
    {
      "id": "<string>",
      "email": null,
      "full_name": null
    }
  ]
}

{
  "message": "<string>",
  "code": 123,
  "status": "<string>"
}

{
  "code": 123,
  "status": "<string>",
  "message": "<string>",
  "errors": {}
}

{
  "code": 123,
  "status": "<string>",
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Provide your API key UUID in the 'Authorization' header prefixed with 'Bearer '. Example: 'Authorization: Bearer 123e4567-e89b-12d3-a456-426614174000'

Query Parameters

limit

integer

default:1000

The number of team members to return (1-1000). Defaults to the maximum, so omitting it returns every team member.

Required range: 1 <= x <= 1000

offset

integer

default:0

The offset for the list of team members.

Required range: x >= 0

team_id

string | null

Filter team members by team ID. If not provided, returns team members for all teams in the organization.

Response

team_members

object[]

required

A list of team members.

Show child attributes

Get team members

curl --request GET \
  --url https://app.ribbon.ai/be-api/v1/team-members \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.ribbon.ai/be-api/v1/team-members', 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://app.ribbon.ai/be-api/v1/team-members",
  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://app.ribbon.ai/be-api/v1/team-members"

	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://app.ribbon.ai/be-api/v1/team-members")

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

{
  "team_members": [
    {
      "id": "<string>",
      "email": null,
      "full_name": null
    }
  ]
}

{
  "message": "<string>",
  "code": 123,
  "status": "<string>"
}

{
  "code": 123,
  "status": "<string>",
  "message": "<string>",
  "errors": {}
}

{
  "code": 123,
  "status": "<string>",
  "message": "<string>",
  "errors": {}
}