Suggest directory users as team members
curl --request POST \
--url https://api.wirespeed.co/v1/directory/member-suggestions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"search": "<string>",
"size": 10,
"excludeTeamMembers": true,
"includeFinancial": false
}
'import requests
url = "https://api.wirespeed.co/v1/directory/member-suggestions"
payload = {
"search": "<string>",
"size": 10,
"excludeTeamMembers": True,
"includeFinancial": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
search: '<string>',
size: 10,
excludeTeamMembers: true,
includeFinancial: false
})
};
fetch('https://api.wirespeed.co/v1/directory/member-suggestions', 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://api.wirespeed.co/v1/directory/member-suggestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'search' => '<string>',
'size' => 10,
'excludeTeamMembers' => true,
'includeFinancial' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wirespeed.co/v1/directory/member-suggestions"
payload := strings.NewReader("{\n \"search\": \"<string>\",\n \"size\": 10,\n \"excludeTeamMembers\": true,\n \"includeFinancial\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wirespeed.co/v1/directory/member-suggestions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"search\": \"<string>\",\n \"size\": 10,\n \"excludeTeamMembers\": true,\n \"includeFinancial\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wirespeed.co/v1/directory/member-suggestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"search\": \"<string>\",\n \"size\": 10,\n \"excludeTeamMembers\": true,\n \"includeFinancial\": false\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"directoryUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"title": "<string>",
"department": "<string>",
"integrationPlatform": "<string>",
"accessLevel": "admin",
"reasons": [
{
"type": "directory_admin_role",
"detail": "<string>"
}
],
"membershipStatus": "member"
}
],
"hasMore": true
}{
"message": "<string>",
"statusCode": 123,
"code": "<string>",
"params": {},
"validationErrors": [
{
"property": "<string>",
"constraint": "<string>",
"params": {},
"code": "<string>"
}
]
}Directory
Suggest directory users as team members
Without search, returns employees (no guests or non-human identities) in the ADMIN group by an administrator-role rule, title rule or manual assignment, or in the TECHNICAL group by a title rule or manual assignment; FINANCIAL group members are added when includeFinancial is true. Results are ranked strongest signal first, and with excludeTeamMembers omit current, invited and former members. With search, returns any user whose email or a word of whose name starts with the term. Each result carries the relationship of its email to the team.
POST
/
v1
/
directory
/
member-suggestions
Suggest directory users as team members
curl --request POST \
--url https://api.wirespeed.co/v1/directory/member-suggestions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"search": "<string>",
"size": 10,
"excludeTeamMembers": true,
"includeFinancial": false
}
'import requests
url = "https://api.wirespeed.co/v1/directory/member-suggestions"
payload = {
"search": "<string>",
"size": 10,
"excludeTeamMembers": True,
"includeFinancial": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
search: '<string>',
size: 10,
excludeTeamMembers: true,
includeFinancial: false
})
};
fetch('https://api.wirespeed.co/v1/directory/member-suggestions', 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://api.wirespeed.co/v1/directory/member-suggestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'search' => '<string>',
'size' => 10,
'excludeTeamMembers' => true,
'includeFinancial' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wirespeed.co/v1/directory/member-suggestions"
payload := strings.NewReader("{\n \"search\": \"<string>\",\n \"size\": 10,\n \"excludeTeamMembers\": true,\n \"includeFinancial\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wirespeed.co/v1/directory/member-suggestions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"search\": \"<string>\",\n \"size\": 10,\n \"excludeTeamMembers\": true,\n \"includeFinancial\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wirespeed.co/v1/directory/member-suggestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"search\": \"<string>\",\n \"size\": 10,\n \"excludeTeamMembers\": true,\n \"includeFinancial\": false\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"directoryUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"title": "<string>",
"department": "<string>",
"integrationPlatform": "<string>",
"accessLevel": "admin",
"reasons": [
{
"type": "directory_admin_role",
"detail": "<string>"
}
],
"membershipStatus": "member"
}
],
"hasMore": true
}{
"message": "<string>",
"statusCode": 123,
"code": "<string>",
"params": {},
"validationErrors": [
{
"property": "<string>",
"constraint": "<string>",
"params": {},
"code": "<string>"
}
]
}Authorizations
Team API key sent as a Bearer token. Create a key in Wirespeed under Settings → Team. See https://docs.wirespeed.co/api-reference/authentication.
Body
application/json

