List Colleagues API

​

GET /v1/colleagues-list

​

Endpoint URL

​

HTTP Method

​

Headers

​

Query Parameters

​

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)

[
  {
    "id": "tbi_abc123",
    "name": "Jane Colleague",
    "email": "[email protected]",
    "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": "[email protected]",
    "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:
  Copy

  { "error": "Email parameter is required" }
  
• 400 Bad Request - API Key Not Linked:
  Copy

  { "error": "API Key is not linked to a valid organization." }
  
• 401 Unauthorized - API Key Required:
  Copy

  { "error": "API Key is required" }
  
• 401 Unauthorized - Invalid API Key:
  Copy

  { "error": "Invalid API Key or key not linked to an organization" }
  
• 403 Forbidden - Waz Disabled:
  Copy

  { "error": "Waz is currently disabled" }
  
• 500 Internal Server Error:
  Copy

  { "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.