Admin > Users

The following endpoints retrieve information about the users of your Make White Label instance. You can also manage users, for example adding them to organizations and teams.

Get user's detail

get

Retrieves a collection of all users in your Make White Label instance. Use the API call query parameters to limit the results to a user name or user email.

Authorizations

Query parameters

idintegeroptional

Optional filter parameter.

Example: 1

namestringoptional

Optional filter parameter.

emailstringoptional

Optional filter parameter.

colsstring[]optional

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

Example: {"value":["id","name","email"]}

pg[sortBy]string · enumoptional

Sort the results in the APi call response by the values in the specified column.

Available options:

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.

Available options:

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://eu1.make.com/api/v2/admin/users-detail' \
  --header 'Authorization: YOUR_API_KEY'

200

200

List users

Filter results

List users

{
  "users": [
    {
      "id": 15,
      "name": "Rosario",
      "email": "[e-mail]",
      "language": "en",
      "timezoneId": 113,
      "localeId": 19,
      "countryId": 1,
      "features": {},
      "avatar": "https://secure.gravatar.com/avatar/bca593a1166cfebb7453226d5a55f4a5.jpg?d=mm",
      "lastLogin": "2023-01-03T11:24:25.460Z",
      "organizations": 1,
      "scenarios": 0,
      "activeScenarios": 0,
      "deleted": false,
      "created": "2023-01-03T11:12:40.644Z",
      "usersAdminsRoleId": null,
      "tfaEnabled": false
    },
    {
      "id": 14,
      "name": "John Doe",
      "email": "[e-mail]",
      "language": "en",
      "timezoneId": 113,
      "localeId": 19,
      "countryId": 202,
      "features": {},
      "avatar": "https://secure.gravatar.com/avatar/049bebcb7ed96e1539a5ed479ae7158b.jpg?d=mm",
      "lastLogin": null,
      "organizations": 0,
      "scenarios": 0,
      "activeScenarios": 0,
      "deleted": false,
      "created": "2022-12-12T14:24:26.895Z",
      "usersAdminsRoleId": null,
      "tfaEnabled": false
    }
  ],
  "pg": {
    "sortBy": "id",
    "limit": 10,
    "sortDir": "desc",
    "offset": 0
  }
}

Successful response

List users

get

Gets the list of users in a team or an organization.

Authorizations

Query parameters

organizationIdintegeroptional

The ID of the organization.

Example: {"value":22}

teamIdintegeroptional

The ID of the team.

Example: {"value":11}

namestringoptional

The name of the user.

Example: {"value":"John Doe"}

emailstringoptional

The email of the user.

Example: {"value":"[e-mail]"}

teamRoleIdintegeroptional

The ID of the user's role in the team.

Example: {"value":3}

organizationRoleIdintegeroptional

The ID of the user's role in the organization.

Example: {"value":13}

colsstring[]optional

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

Example: {"value":["id","name","email","teamRoleId","organizationRoleId"]}

pg[sortBy]string · enumoptional

Sort the results in the APi call response by the values in the specified column.

Available options:

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.

Available options:

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://eu1.make.com/api/v2/admin/users' \
  --header 'Authorization: YOUR_API_KEY'

200

200

List users

Filter results

List users

{
  "users": [
    {
      "id": 15,
      "name": "Rosario",
      "email": "[e-mail]",
      "language": "en",
      "timezoneId": 113,
      "localeId": 19,
      "countryId": 1,
      "features": {},
      "avatar": "https://secure.gravatar.com/avatar/bca593a1166cfebb7453226d5a55f4a5.jpg?d=mm",
      "lastLogin": "2023-01-03T11:24:25.460Z",
      "deleted": false,
      "created": "2023-01-03T11:12:40.644Z",
      "usersAdminsRoleId": null
    },
    {
      "id": 14,
      "name": "John Doe",
      "email": "[e-mail]",
      "language": "en",
      "timezoneId": 113,
      "localeId": 19,
      "countryId": 202,
      "features": {},
      "avatar": "https://secure.gravatar.com/avatar/049bebcb7ed96e1539a5ed479ae7158b.jpg?d=mm",
      "lastLogin": null,
      "deleted": false,
      "created": "2022-12-12T14:24:26.895Z",
      "usersAdminsRoleId": null
    }
  ],
  "pg": {
    "sortBy": "id",
    "limit": 10,
    "sortDir": "desc",
    "offset": 0
  }
}

Successful response

Create a new user

post

Creates a new user. Specify the user's name and email in the request body.

You have to either send an invitation mail to the user with the sendEmail: true or you have to specify the user password in the password field in the request body. If you send the invitation mail, the mail contains automatically generated password. The user has to change their password right after logging in.

You can also set the user's country, locale and timezone with the request body parameters. If you don't specify the user's country, locale or timezone Make uses your account's country, locale or timezone.

Authorizations

Body

namestringrequired

The name of the user.

emailstringrequired

The user's email.

passwordstringoptional

The password to the user's account. It has to contain at least 10 characters, including one number, one upper case character and one special character.

sendEmailbooleanoptional

If set to true, Make sends an email to the user with their automatically generated password. The user has to change their password right after logging in.

countryIdintegeroptional

The ID of user's country. Get the countryId values with the API call GET /enums/countries.

timezoneIdintegeroptional

The ID of user's timezone. Get the list of the timezone IDs with the API call GET /enums/timezones.

localeIdintegeroptional

The ID of user's locale. Get the list of locale IDs with the API call GET /enums/locales.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://eu1.make.com/api/v2/admin/users' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "John Doe",
    "email": "[e-mail]",
    "sendEmail": false,
    "timezoneId": 113,
    "localeId": 18,
    "countryId": 1,
    "password": "my-Password1?"
  }'

Create userSend invitation email

200

200

setAll

sendEmail

setAll

{
  "user": {
    "id": 5,
    "name": "John Doe",
    "email": "[e-mail]",
    "language": "en",
    "timezoneId": 113,
    "localeId": 18,
    "countryId": 1,
    "features": {},
    "avatar": "https://secure.gravatar.com/avatar/b38336ad1642bc8effb596db864be1f1.jpg?d=mm",
    "lastLogin": null,
    "organizations": 0,
    "scenarios": 0,
    "activeScenarios": 0,
    "deleted": false,
    "created": "2023-01-17T12:41:10.697Z",
    "usersAdminsRoleId": null,
    "tfaEnabled": false
  }
}

Successful response

Delete a user

delete

Deletes the user with the specified userId. Use the deleteConnections query parameter to delete the user's connections too.

Authorizations

Path parameters

userIdintegerrequired

The ID of the user.

Example: 22

Query parameters

deleteConnectionsbooleanoptional

Set to true to delete also user's connections when removing organizations, in which the user has the role "Owner". The default value is false.

Example: true

confirmedbooleanoptional

Set to true to delete organizations in which the user has the "Owner" role. Use the parameter deleteConnections to delete the user's connections in the deleted organizations.

Example: true

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://eu1.make.com/api/v2/admin/users/{userId}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "user": 22
}

Successful response

Update user information

patch

Updates user information. Make updates only the specified information.

In addition, you can set the user admin roles in the usersAdminsRoleId. Check the available roles with the API call GET /admin/users/admins-roles. Refer to the user admin roles documentation for the full breakdown of the user admin roles permissions.

Authorizations

Path parameters

userIdintegerrequired

The ID of the user.

Example: 22

Body

namestringoptional

The name of the user.

emailstringoptional

The user's email.

languagestringoptional

The language of the user's UI. Currently, Make has the full UI in english only (value en).

countryIdintegeroptional

The ID of user's country. Get the countryId values with the API call GET /enums/countries.

timezoneIdintegeroptional

The ID of user's timezone. Get the list of the timezone IDs with the API call GET /enums/timezones.

localeIdintegeroptional

The ID of user's locale. Get the list of locale IDs with the API call GET /enums/locales.

usersAdminsRoleIdintegeroptional

The ID of the admin user's role. Get the list of available user admin roles and their IDs with the API call GET /admin/users/admins-roles.

Refer to the user admin roles documentation for the full breakdown of the user admin roles permissions.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://eu1.make.com/api/v2/admin/users/{userId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Jane Porter",
    "email": "[e-mail]",
    "usersAdminsRoleId": 4
  }'

200

200

{
  "user": {
    "id": 6,
    "name": "Jane Porter",
    "email": "[e-mail]",
    "language": "en",
    "timezoneId": 113,
    "localeId": 18,
    "countryId": 1,
    "features": {},
    "avatar": "https://secure.gravatar.com/avatar/b38336ad1642bc8effb596db864be1f1.jpg?d=mm",
    "lastLogin": null,
    "organizations": 0,
    "scenarios": 0,
    "activeScenarios": 0,
    "deleted": false,
    "created": "2023-01-17T12:41:10.697Z",
    "usersAdminsRoleId": 4,
    "tfaEnabled": false
  }
}

Successful response

Set user organization role

post

Sets user role in the organization. Specify the user organization role ID in the request body. Get all available user role IDs and the corresponding user role names with the API call GET /users/roles.

If the user is not a member of the organization, the API call adds the user to the organization with the specified role. If you add the user to the organization as "Admin" (usersRoleId = 12) and the organization has teams, Make assigns the user to the organization as the organization "Admin" and to all teams in the organization as "Team Admin". Once you add a user as "Team Admin" you cannot change their team role. The only option to change the "Team Admin" role is to remove the user from the team and re-add them with the specified team role.

If you add the user to the organization with a role other than "Admin" Make doesn't add the user to any organization's teams. In the Administration interface, the user appears with the role "None" in all teams in the organization. The users with the role "None" in a team or an organization cannot access the team or organization data in any way.

You cannot change the organization "Owner" with this endpoint. Use the API call to transfer organization ownership instead.

To remove a user from an organization, send an empty request body. The API call removes the user with the specified userId from the organization, setting the user's organization role to "None".

Authorizations

Path parameters

userIdintegerrequired

The ID of the user

Example: 5

organizationIdintegerrequired

The ID of the organization.

Example: 22

Query parameters

colsstring[]optional

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

Example: {"value":["userId","organizationId","usersRoleId","invitation","organizationTeamsCount","joinedTeamsCount","ssoPending"]}

deleteConnectionsbooleanoptional

When removing the user from the organization, set to true to delete also user's connections. The default value is false. To confirm deleting the user's connections you have to also set the confirmed parameter to true.

Example: {"value":true}

confirmedbooleanoptional

Set to true to confirm deleting the user's connections in combination with the deleteConnections parameter. Otherwise, the API call fails with error requiring confirmation.

Example: {"value":true}

Body

usersRoleIdintegeroptional

The ID of the user role. Check the GET /users/roles API call for the available usersRoleId values.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://eu1.make.com/api/v2/admin/users/{userId}/user-organization-roles/{organizationId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "usersRoleId": 13
  }'

Set user roleSet user data all colsRemove user from organization

200

200

set-user-role

all-cols

remove-user

set-user-role

{
  "userOrganizationRole": {
    "userId": 5,
    "organizationId": 22,
    "usersRoleId": 13,
    "invitation": null,
    "ssoPending": false
  }
}

Successful response

Transfer organization ownership

post

Transfer organization ownership to the user with the specified userId.

Authorizations

Path parameters

userIdintegerrequired

The ID of the user.

Example: 22

organizationIdintegerrequired

The ID of the organization.

Example: 11

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://eu1.make.com/api/v2/admin/users/{userId}/user-organization-roles/{organizationId}/transfer' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "userOrganizationRoles": [
    {
      "userId": 22,
      "organizationId": 11,
      "usersRoleId": 11,
      "invitation": null
    },
    {
      "userId": 1,
      "organizationId": 11,
      "usersRoleId": 12,
      "invitation": null
    }
  ]
}

Successful response

Set user team role

post

Sets the user role in the team. Specify the user team role ID in the request body. The user has to be already a member of the team's organization.

Get all available user role IDs and the corresponding user role names with the API call GET /users/roles.

If the user is not a member of the team, the API call adds the user to the team with the specified role. If you send an empty request body, the API call removes the user with the specified userId from the team, setting the user's team role to "None".

Authorizations

Path parameters

userIdintegerrequired

The ID of the user.

Example: 111

teamIdintegerrequired

The ID of the team.

Example: 22

Query parameters

confirmedbooleanoptional

Use this parameter when you are removing a user from a team. Set this parameter to true is you want to delete the user's connections from the team with the parameter deleteConnections.

Example: {"value":true}

deleteConnectionsbooleanoptional

Set this parameter to true if you are removing a user from a team to delete also the user's connections. If you set this parameter to false, the API call won't delete the user's connections.

Example: {"value":true}

Body

usersRoleIdintegeroptional

The ID of the user role. Check the GET /users/roles API call for the available usersRoleId values.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://eu1.make.com/api/v2/admin/users/{userId}/user-team-roles/{teamId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "usersRoleId": 3
  }'

Set user team roleRemove user

200

200

set-role

remove-user

set-role

{
  "userTeamRole": {
    "usersRoleId": 3,
    "userId": 111,
    "teamId": 22,
    "changeable": true,
    "ssoPending": false
  }
}

Successful response