Class Teams

Class providing methods for working with Make teams. Teams are workspaces for organizing scenarios, users, and resources within an organization. Each user can be a member of multiple teams and have different roles in each.

Index

Constructors

constructor

Methods

create delete get list

Constructors

constructor

new Teams(fetch: FetchFunction): Teams
Create a new Teams instance.
Parameters
- fetch: FetchFunction
  Function for making API requests
Returns Teams
- Defined in src/endpoints/teams.ts:124

Methods

create

create(body: CreateTeamBody): Promise<Team>
Create a new team.
Parameters
- body: CreateTeamBody
  The team configuration
Returns Promise<Team>
Promise with the created team
Example
```
const team = await make.teams.create({
  name: 'My Team',
  organizationId: 123
});
```
- Defined in src/endpoints/teams.ts:197

delete

delete(teamId: number): Promise<void>
Delete a team.
Parameters
- teamId: number
  The team ID to delete
Returns Promise<void>
Promise that resolves when the team is deleted
Example
```
await make.teams.delete(123);
```
- Defined in src/endpoints/teams.ts:216

get

get<C extends keyof Team = never>(
teamId: number,
options?: GetTeamOptions<C>,
): Promise<PickColumns<Team, C>>
Get details of a specific team.
Type Parameters
- C extends keyof Team = never
Parameters
- teamId: number
  The team ID to get
- Optionaloptions: GetTeamOptions<C>
  Optional parameters for filtering returned fields
Returns Promise<PickColumns<Team, C>>
Promise with the team information
Example
```
const team = await make.teams.get(123);
```
- Defined in src/endpoints/teams.ts:171

list

list<C extends keyof Team = never>(
organizationId: number,
options?: ListTeamsOptions<C>,
): Promise<PickColumns<Team, C>[]>
List all teams in an organization.
Type Parameters
- C extends keyof Team = never
Parameters
- organizationId: number
  The organization ID to list teams for
- Optionaloptions: ListTeamsOptions<C>
  Optional parameters for filtering and pagination
Returns Promise<PickColumns<Team, C>[]>
Promise with the list of teams
Example
```
// List all teams in organization 123
const teams = await make.teams.list(123);

// List teams with pagination
const teams = await make.teams.list(123, {
  pg: { sortBy: 'name', sortDir: 'asc' }
});
```
- Defined in src/endpoints/teams.ts:145

Class Teams

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Teams

Methods

create

Parameters

Returns Promise<Team>

Example

delete

Parameters

Returns Promise<void>

Example

get

Type Parameters

Parameters

Returns Promise<PickColumns<Team, C>>

Example

list

Type Parameters

Parameters

Returns Promise<PickColumns<Team, C>[]>

Example

Settings

On This Page