Skip to main content
GET

Get Teams

Retrieve a paginated list of all teams in your organization with their basic information.

Authentication

This endpoint requires Console API authentication with bearer token and x-source: console header.
string
required
Bearer token for authentication. Format: Bearer YOUR_ACCESS_TOKEN
string
required
Source identifier. Must be set to console for all Console API requests.

Query Parameters

integer
default:"1"
Page number for pagination. Must be a positive integer.
integer
default:"10"
Number of teams per page. Range: 1-100.

Response Fields

object
required
Teams data object containing the list of teams and pagination information.
string
required
Human-readable message describing the result of the operation.
string
required
Operation status. Always “success” for successful requests.

Error Responses

Causes:
  • Missing or invalid access token
  • Expired access token
  • Missing x-source header
Causes:
  • User lacks team viewing permissions
  • User is not a member of the organization
Causes:
  • Invalid page number (negative or zero)
  • Invalid limit value (outside 1-100 range)

Usage Examples

Pagination Examples

Best Practices

  • Use appropriate page sizes (10-50 items per page)
  • Implement proper pagination controls in your UI
  • Cache results when possible to reduce API calls
  • Handle empty results gracefully
  • Use reasonable page limits to avoid large responses
  • Implement client-side caching for frequently accessed data
  • Consider implementing search and filtering on the client side
  • Handle pagination parameter validation errors
  • Implement retry logic for transient failures
  • Provide fallback UI for empty team lists

Create Team

Create a new team in your organization.

Get Team Members

View members of a specific team.

Invite Team Member

Add new members to a team.

Delete Team

Remove a team from your organization.
Pro Tip: Use pagination to efficiently load teams in your UI. Start with a reasonable page size (10-20) and implement “Load More” functionality for better user experience.