Admin > Teams

The following endpoint allows you to create new teams within organizations in the Make White Label product. You can set the team admin directly in the API call request body.

List teams

get
/admin/teams

Gets the list of teams in the organization with the specified organizationId.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
organizationIdintegerRequired

The ID of the organization.

Example: 22
externalIdstringOptional

Custom team ID from an external system to the Make White Label platform.

pg[sortBy]string · enumOptional

The value that will be used to sort returned entities by.

Possible values:
pg[offset]integerOptional

The value of entities you want to skip before getting entities you need.

pg[sortDir]string · enumOptional

The sorting order. It accepts the ascending and descending direction specifiers.

Possible values:
pg[limit]integerOptional

Sets the maximum number of results per page in the API call response. For example, pg[limit]=100. The default number varies with different API endpoints.

Responses
200

Successful response

application/json
get
/admin/teams
GET /api/v2/admin/teams?organizationId=1 HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "teams": [
    {
      "id": 38,
      "name": "Management",
      "organizationId": 22,
      "scenarioDrafts": false,
      "deleted": false,
      "externalId": null
    },
    {
      "id": 36,
      "name": "Removed team",
      "organizationId": 20,
      "scenarioDrafts": false,
      "deleted": true,
      "externalId": null
    }
  ],
  "pg": {
    "sortBy": "name",
    "limit": 10000,
    "sortDir": "asc",
    "offset": 0
  }
}

Create a team

post
/admin/teams

Creates a new team in the specified organization.

You can set the team admin with the parameter userTeamAdmin in the request body. If you don't use the userTeamAdmin parameter and you are part of the organization, then Make sets you as the team admin.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body
namestringRequired

The name of the team.

organizationIdintegerRequired

The ID of the organization.

userTeamAdminintegerOptional

Set the user with the specified userId as the admin of the team.

Responses
200

Successful response

application/json
post
/admin/teams
POST /api/v2/admin/teams HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "Marketing team",
  "organizationId": 20,
  "userTeamAdmin": 15
}
200

Successful response

{
  "team": {
    "id": 26,
    "name": "Marketing team",
    "organizationId": 20
  },
  "userTeamRole": {
    "usersRoleId": 1,
    "userId": 15,
    "teamId": 26,
    "changeable": false,
    "ssoPending": false
  }
}

Delete a team

delete
/admin/teams/{teamId}

Deletes the team with the specified teamId. Make removes all users from the deleted team and deletes all data associated with the team, such as data stores and scenarios.

The team won't be visible for the users. However, if you run the API call GET /admin/teams the response will contain also the deleted team with the deleted: true pair. Similarly, the team will remain visible in the Administration UI.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
teamIdintegerRequired

The ID of the team.

Example: 22
Responses
200

Successful response

application/json
delete
/admin/teams/{teamId}
DELETE /api/v2/admin/teams/{teamId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "team": 22
}

Update team

patch
/admin/teams/{teamId}

Updates team information. Make updates only the values in the request body.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
teamIdintegerRequired

The ID of the team.

Example: 56
Body
namestringOptional

The name of the team.

Responses
200

Successful response

application/json
patch
/admin/teams/{teamId}
PATCH /api/v2/admin/teams/{teamId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "name": "Sales people team"
}
200

Successful response

{
  "id": 56,
  "name": "Sales people team",
  "organizationId": 22,
  "scenarioDrafts": false,
  "deleted": false,
  "externalId": null
}

Last updated