/teams

GET /teams

Get all teams

Retrieve a paginated list of teams with optional filtering

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

Optional Parameters

Click here to view an exhaustive list of all available parameters

page query integer

Page number

pageSize query integer

Number of teams per page

search query string

Search all teams for any text that matches the search query (not case sensitive)

sort query string

Comma separated list of fields to sort by, prefix with - for descending order. (ie. sort=name,-createdAt)

active query boolean

Filter teams by active status. By default, only active teams are shown.

name query string

Filter teams by name

Try it out

Output:

Responses

Description

Successful response

{
  "data": [
    {
      "id": 0,
      "account_id": "string",
      "accountId": "string",
      "name": "string",
      "active": true,
      "members": [
        {
          "userId": 0,
          "email": "string",
          "name": "string"
        }
      ],
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0,
  "currentPage": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/TeamMember #/components/schemas/Team #/components/schemas/TeamList

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/TeamMember

OpenAPI
TypeScript

type: object
description: User who is a member of a team
properties:
  userId:
    type: integer
    description: ID of the user
  email:
    type: string
    description: Email of the user
  name:
    type: string
    description: Name of the user
required:
  - userId
  - email

|
export interface TeamMember {
  /** ID of the user */
  userId: number;
  /** Email of the user */
  email: string;
  /** Name of the user */
  name?: string;
}

#/components/schemas/Team

OpenAPI
TypeScript

type: object
description: Team information
properties:
  id:
    type: integer
    description: Team ID
    readOnly: true
  account_id:
    type: string
    description: ID of the account that owns this team
  accountId:
    type: string
    description: ID of the account that owns this team
  name:
    type: string
    description: Team name
  active:
    type: boolean
    default: true
    description: Whether the team is active
  members:
    type: array
    items:
      $ref: "#/components/schemas/TeamMember"
    description: Users who are members of this team
  createdBy:
    type: string
    description: Email of the user who created the team
  updatedBy:
    type: string
    description: Email of the user who last updated the team
  createdAt:
    type: string
    format: date-time
    description: When the team was created
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    description: When the team was last updated
    readOnly: true
required:
  - name

|
export interface Team {
  /** Team ID */
  id?: number;
  /** ID of the account that owns this team */
  account_id?: string;
  /** ID of the account that owns this team */
  accountId?: string;
  /** Team name */
  name: string;
  /** Whether the team is active */
  active?: boolean;
  /** Users who are members of this team */
  members?: TeamMember[];
  /** Email of the user who created the team */
  createdBy?: string;
  /** Email of the user who last updated the team */
  updatedBy?: string;
  /** When the team was created */
  createdAt?: Date;
  /** When the team was last updated */
  updatedAt?: Date;
}

#/components/schemas/TeamList

OpenAPI
TypeScript

type: object
properties:
  data:
    type: array
    items:
      $ref: "#/components/schemas/Team"
  totalCount:
    type: integer
  totalPages:
    type: integer
  currentPage:
    type: integer

|
export interface TeamList {
  data?: Team[];
  totalCount?: number;
  totalPages?: number;
  currentPage?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /teams/route.ts

Or the swagger.yaml spec this documentation was generated from: /teams/swagger.yaml