Users

The following main user endpoints allow you to get a list of existing users and manage their basic details such as password change.

List users

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/users

Retrieves a collection of all users for a team or an organization with a given ID. Returned users are sorted by id in descending order.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

organizationIdintegerOptional

The unique ID of the organization whose users will be retrieved. If this parameter is set, the teamId parameter must be skipped. For each request either teamId or organizationId must be defined.

teamIdintegerOptional

The unique ID of the team whose users will be retrieved. If this parameter is set, the organizationId parameter must be skipped. For each request either teamId or organizationId must be defined.

Example: 1

namestringOptional

Optional filter parameter.

emailstringOptional

Optional filter parameter.

teamRoleIdintegerOptional

Optional filter parameter. If this parameter is set, the teamId parameter must be set as well.

Example: {"value":3}

organizationRoleIdintegerOptional

Optional filter parameter. If this parameter is set, the organizationId parameter must be set as well.

Example: {"value":13}

pg[sortBy]string · enumOptional

The value that will be used to sort returned entities by. Users can be sorted by name, id and email.

Possible values:

pg[sortDir]string · enumOptional

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

Possible values:

pg[offset]integerOptional

The number of entities you want to skip before getting entities you want.

pg[limit]integerOptional

The maximum number of entities you want to get in the response.

Responses

200

Successful response

application/json

get

/users

HTTPcURLJavaScriptPython

GET /api/v2/users HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "users": [
    {
      "id": 1,
      "name": "Administrator",
      "email": "[email protected]",
      "language": "en",
      "timezoneId": 113,
      "localeId": 18,
      "countryId": 202,
      "features": {},
      "avatar": "https://secure.gravatar.com/avatar/6b1a74d20d925c12a73af32bf0dd7164.jpg?d=mm",
      "lastLogin": "2022-04-04T10:23:34.347Z"
    }
  ],
  "pg": {
    "sortBy": "name",
    "sortDir": "desc",
    "offset": 0,
    "limit": 10
  }
}

Delete current user

delete

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/users

Deletes the authenticated user's own account. Requires password and/or 2FA, if configured. Optionally deletes all user connections (accounts, webhooks, etc).

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

application/json

deleteConnectionsbooleanOptional

Whether to delete all user connections (accounts, webhooks, etc).

Default: false

currentPasswordstringOptional

User's current password (required if user has a password set).

tfaCodestringOptional

Two-factor authentication code (required if 2FA is enabled).

Responses

200

Successful response

application/json

delete

/users

HTTPcURLJavaScriptPython

DELETE /api/v2/users HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "deleteConnections": false,
  "currentPassword": "text",
  "tfaCode": "text"
}

200

Successful response

{
  "user": 3
}

Update user

patch

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/users/{userId}

Updates a user with a given ID by passing new data in the request body. Any property that is not provided will be left unchanged. As the response, it returns all details of the updated user including properties that were not changed.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

userIdstringRequired

The unique ID of the user. It can be retrieved from the List users endpoint.

Example: 1

Body

application/json

namestringOptional

The name of the user. The name must be at most 250 characters long and does not need to be unique.

languagestringOptional

The standardized language code. It sets the Make environment language.

timezoneIdintegerOptional

The timezone ID corresponding to the local time. The list of all timezones can be retrieved from the GET /enums/timezones endpoint.

localeIdintegerOptional

The location ID. It sets the Make environment date formats, hour formats, decimal separators, etc. The list of all locales can be retrieved from the GET /enums/locales endpoint.

countryIdintegerOptional

The country ID. It sets the region of use.

Responses

200

Successful response

application/json

patch

/users/{userId}

HTTPcURLJavaScriptPython

PATCH /api/v2/users/{userId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "name": "admin",
  "language": "en",
  "localeId": 18,
  "timezoneId": 113,
  "countryId": 1
}

200

Successful response

{
  "user": {
    "id": 1,
    "name": "Administrator",
    "email": "[email protected]",
    "language": "en",
    "timezoneId": 113,
    "localeId": 18,
    "countryId": 202,
    "features": {},
    "avatar": "https://secure.gravatar.com/avatar/6b1a74d20d925c12a73af32bf0dd7164.jpg?d=mm",
    "lastLogin": "2022-04-04T10:23:34.347Z"
  }
}

Update user email

put

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/users/{userId}/attributes/email

Updates an email for a user with a given ID by passing new data in the request body. It replaces the entire resource with the new values. In the response, it returns the confirmation if the email was changed.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

userIdstringRequired

The unique ID of the user. It can be retrieved from the List users endpoint.

Example: 1

Body

application/json

currentEmailAddressstring · emailRequired

User's current email address.

newEmailAddressstring · emailRequired

User's new email address.

currentPasswordstring · passwordRequired

User's current password.

Responses

200

Successful response

application/json

put

/users/{userId}/attributes/email

HTTPcURLJavaScriptPython

PUT /api/v2/users/{userId}/attributes/email HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "currentEmailAddress": "[email protected]",
  "newEmailAddress": "[email protected]",
  "currentPassword": "123456Ab-"
}

200

Successful response

{
  "changed": false,
  "emailSent": true
}

Update user password

put

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/users/{userId}/attributes/password

Updates a password for a user with a given ID by passing new data in the request body. It replaces the entire resource with the new values. In the response, it returns the confirmation if the password was changed. This endpoint corresponds to changing a password in the user profile when the user is logged in to the Make interface.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

userIdstringRequired

The unique ID of the user. It can be retrieved from the List users endpoint.

Example: 1

Body

application/json

currentPasswordstring · passwordRequired

The current user password.

newPassword1string · passwordRequired

The new user password. The password must be at least 9 characters long and must contain at least one uppercase letter, at least one number, and at least one special character.

newPassword2string · passwordRequired

The new user password for confirmation. This password must be the same as the password in the newPassword1 property.

Responses

200

Successful response

application/json

put

/users/{userId}/attributes/password

HTTPcURLJavaScriptPython

PUT /api/v2/users/{userId}/attributes/password HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "currentPassword": "123456Ab.",
  "newPassword1": "123456Ab-",
  "newPassword2": "123456Ab-"
}

200

Successful response

{
  "changed": true
}

Send password reset demand

post

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/users/password-reset-demand

Sends password reset demand for a user with an email passed in the request body. This endpoint corresponds to the Lost password function on the login page in the Make interface. In the response, it returns the confirmation if the demand was sent successfully.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

application/json

emailstring · emailRequired

The email of the user for who the password should be reset.

Responses

200

Successful response

application/json

post

/users/password-reset-demand

HTTPcURLJavaScriptPython

POST /api/v2/users/password-reset-demand HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "email": "[email protected]"
}

200

Successful response

{
  "ok": 1
}

Set session for resetting lost password

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/users/password-reset

Checks a hash and sets a session for the Reset lost password endpoint. This endpoint corresponds to clicking the Reset password link in the Password reset email.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

hashstringOptional

The unique hash of the password reset session.

Example: fab680b60044adb766128e713e44e15b

Responses

200

Successful response

application/json

get

/users/password-reset

HTTPcURLJavaScriptPython

GET /api/v2/users/password-reset HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "ok": 1
}

Reset lost password

post

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/users/password-reset

Updates a password for a user based on the session created when calling the Prepare session for password reset endpoint. This endpoint corresponds to setting a new password on the Lost password page in the Make interface.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

application/json

newPassword1stringRequired

The new user password.

newPassword2stringRequired

This password must be the same as the password in the newPassword1 property.

Responses

200

Successful response

application/json

post

/users/password-reset

HTTPcURLJavaScriptPython

POST /api/v2/users/password-reset HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "newPassword1": "Aa123456.",
  "newPassword2": "Aa123456."
}

200

Successful response

{
  "ok": 1
}