List Colleagues
curl --request GET \
--url https://api.wazper.com/v1/colleagues-list \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.wazper.com/v1/colleagues-list"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.wazper.com/v1/colleagues-list', 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.wazper.com/v1/colleagues-list",
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: <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://api.wazper.com/v1/colleagues-list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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://api.wazper.com/v1/colleagues-list")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wazper.com/v1/colleagues-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"jobTitle": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"companyName": "<string>",
"website": "<string>",
"inviteLink": "<string>",
"redirectionLink": "<string>",
"photo": "<string>",
"team": 123,
"wazClientId": "<string>",
"toBeInvitedById": "jsmith@example.com",
"latestAction": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]Endpoints
List Colleagues API
API for listing colleagues (potential invitees) for a user within a client organization.
GET
/
v1
/
colleagues-list
List Colleagues
curl --request GET \
--url https://api.wazper.com/v1/colleagues-list \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.wazper.com/v1/colleagues-list"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.wazper.com/v1/colleagues-list', 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.wazper.com/v1/colleagues-list",
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: <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://api.wazper.com/v1/colleagues-list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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://api.wazper.com/v1/colleagues-list")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wazper.com/v1/colleagues-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"jobTitle": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"companyName": "<string>",
"website": "<string>",
"inviteLink": "<string>",
"redirectionLink": "<string>",
"photo": "<string>",
"team": 123,
"wazClientId": "<string>",
"toBeInvitedById": "jsmith@example.com",
"latestAction": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]GET /v1/colleagues-list
This endpoint is used to retrieve a list of colleagues associated with a specific user.
When it is called, it will return all colleagues that have been created for the specified user and are available for invitation.
Endpoint URL
The endpoint URL ishttps://api.wazper.com/v1/colleagues-list
HTTP Method
GET
Headers
| Header | Type | Required | Description |
|---|---|---|---|
X-API-Key | String | Yes | Your Wazper API Key. |
Accept | String | No | Recommended application/json. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | String | Yes | The email address of the user whose colleagues you want to retrieve. |
Example Request (cURL)
curl -X GET 'https://api.wazper.com/v1/colleagues-list?email=current.user%40example.com' \
-H 'X-API-Key: YOUR_API_KEY'
Success Response (200 OK)
The response contains an array of colleague objects, sorted with joined colleagues first, then by photo presence, and finally by creation date.[
{
"id": "tbi_abc123",
"name": "Jane Colleague",
"email": "jane.colleague@example.com",
"jobTitle": "Product Manager",
"status": "pending",
"createdAt": "2023-10-26T10:00:00.000Z",
"companyName": "Example Inc.",
"website": "https://example.com",
"inviteLink": "https://app.wazper.com/invite/xyz789",
"redirectionLink": "https://app.wazper.com/dashboard",
"photo": null
},
{
"id": "tbi_def456",
"name": "John Teammate",
"email": "john.teammate@example.com",
"jobTitle": "Engineer",
"status": "joined",
"createdAt": "2023-10-25T10:00:00.000Z",
"companyName": "Example Inc.",
"website": null,
"inviteLink": "https://app.wazper.com/invite/uvw456",
"redirectionLink": "https://app.wazper.com/dashboard",
"photo": "https://cdn.example.com/john.png"
}
]
Error Responses
-
400 Bad Request - Email Parameter Missing:
{ "error": "Email parameter is required" } -
400 Bad Request - API Key Not Linked:
{ "error": "API Key is not linked to a valid organization." } -
401 Unauthorized - API Key Required:
{ "error": "API Key is required" } -
401 Unauthorized - Invalid API Key:
{ "error": "Invalid API Key or key not linked to an organization" } -
403 Forbidden - Waz Disabled:
{ "error": "Waz is currently disabled" } -
500 Internal Server Error:
{ "error": "Internal server error", "details": "The error message from the server." }
Notes
- This API does not consume credits from your account.
- Results are limited to 50 colleagues maximum.
- Colleagues with “deleted” status are excluded from the results.
- The list is sorted to show joined colleagues first, then colleagues with photos, and finally by newest creation date.
Authorizations
Query Parameters
The email address of the user whose colleagues are to be listed.
Response
A list of colleagues.
Unique ID of the colleague entry (ToBeInvited table).
Name of the colleague.
Email of the colleague.
Job title.
Current status (e.g., pending, invited, joined).
Creation timestamp.
Company name.
Website URL.
Invite link.
Redirection link.
Photo URL.
Team identifier.
Wazper Client ID.
Email of the user who created this entry.
Timestamp of the last action.
Timestamp of last update.