GET
/
v1
/
colleagues-list
List Colleagues
curl --request GET \
  --url https://api.wazper.com/v1/colleagues-list \
  --header 'X-API-Key: <api-key>'
[
  {
    "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 is https://api.wazper.com/v1/colleagues-list

​
HTTP Method

GET

​
Headers

HeaderTypeRequiredDescription
X-API-KeyStringYesYour Wazper API Key.
AcceptStringNoRecommended application/json.

​
Query Parameters

ParameterTypeRequiredDescription
emailStringYesThe 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

​
X-API-Key
string
header
required

Query Parameters

​
email
string<email>
required

The email address of the user whose colleagues are to be listed.

Response

200
application/json

A list of colleagues.

The response is of type object[].