List team members

Lists all team members in the workspace.

GET /team-members

List all team members

cURL

curl --request GET \
  --url https://{your-subdomain}.neetodesk.com/api/external/v2/team-members \
  --header 'X-Api-Key: <x-api-key>'

import requests

url = "https://{your-subdomain}.neetodesk.com/api/external/v2/team-members"

headers = {"X-Api-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://{your-subdomain}.neetodesk.com/api/external/v2/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://{your-subdomain}.neetodesk.com/api/external/v2/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 => [
    "X-Api-Key: <x-api-key>"
  ],
]);

$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://{your-subdomain}.neetodesk.com/api/external/v2/team-members"

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

	req.Header.Add("X-Api-Key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{your-subdomain}.neetodesk.com/api/external/v2/team-members")
  .header("X-Api-Key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{your-subdomain}.neetodesk.com/api/external/v2/team-members")

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

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<x-api-key>'

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

200

{
  "team_members": [
    {
      "id": "aaaabbbb-cccc-dddd-eeee-ffff00001111",
      "email": "[e-mail]",
      "first_name": "Oliver",
      "last_name": "Smith",
      "time_zone": "Asia/Kolkata",
      "profile_image_url": "https://example.com/avatar.png",
      "organization_role": "Admin",
      "active": true
    }
  ],
  "pagination": {
    "total_records": 95,
    "total_pages": 4,
    "current_page_number": 1,
    "page_size": 30
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key · string · default: your-api-key · required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Query Parameters

page_number · integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

page_size · integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

email · string

Filter team members by email address.

Response

200 - application/json

OK - Request succeeded

team_members · object[]

Hide child attributes

team_members. id · string

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00001111"

team_members. email · string

Example:

"[e-mail]"

team_members. first_name · string

Example:

"Oliver"

team_members. last_name · string

Example:

"Smith"

team_members. time_zone · string

Example:

"Asia/Kolkata"

team_members. profile_image_url · string | null

Example:

"https://example.com/avatar.png"

team_members. organization_role · string

Example:

"Admin"

team_members. active · boolean

Example:

true

pagination · object

Hide child attributes

pagination. total_records · integer

Example:

95

pagination. total_pages · integer

Example:

4

pagination. current_page_number · integer

Example:

1

pagination. page_size · integer

Example:

30