Skip to main content
GET
Get all team members

Overview

Retrieve a complete list of all team members (agents) in your organization. This endpoint returns essential information about each team member including their ID, name, email, and phone number. Use this endpoint to display team members in dropdowns, build agent assignment interfaces, or sync team data with external systems.

Use Cases

  • Agent Assignment UI: Populate dropdowns for assigning conversations to specific agents
  • Team Directory: Display a list of all team members in your application
  • Reporting & Analytics: Get agent IDs for filtering analytics by team member
  • External Integrations: Sync team member data with external CRM or HR systems
  • Automated Workflows: Programmatically assign tasks or tickets to specific team members
  • Team Management: Build custom team management interfaces

Authentication

This endpoint requires authentication using an API key. Include your API key in the request header:

Response Structure

The endpoint returns an array of team member objects:

Team Member Object

Example Response

Common Use Cases

1. Populate Agent Selection Dropdown

2. Find Team Member by Email

3. Display Team Directory

4. Get Team Member Count and Stats

5. Sync with External System

6. Build Assignment Interface

Response Characteristics

  • Array Format: Always returns an array, even if empty
  • Alphabetical Order: Team members are returned in the order they exist in the database (not sorted)
  • Active Members Only: Only returns active team members (not deactivated accounts)
  • Organization Scoped: Returns only team members from your organization

Error Responses

Performance Tips

  • Cache the Results: Team member lists typically don’t change frequently - consider caching for 5-10 minutes
  • Client-side Filtering: After fetching all members, filter on the client side rather than making multiple API calls
  • Lazy Loading: For large teams, consider implementing pagination on the frontend
  • Update on Changes: Refresh the list when team members are added or removed

Notes

  • Team Member vs Agent: These terms are used interchangeably - a team member is any user who can be assigned to conversations
  • Role Information: This endpoint doesn’t return role/permission information - it only returns basic contact details
  • ID Format: Team member IDs are UUIDs that can be used with the assignment endpoint
  • Name Concatenation: The name field is automatically generated from first_name + ' ' + last_name

Headers

x-api-key
string
required

API key needed to authorize the request

Response

All team members found.

The response is of type object.