Users
Retrieve users
Required scope: users:read
Organization authorization: supported
query Parameters
pagepage number to retrieve (starts with 0)
perPagenumber of items per page (between 1 and 100, default 10)
emailfilter user by email
phonefilter user by phone
includeDeletedSet to 'true' to include deleted users, 'false' otherwise
fromUpdatedAtFilter to retrieve users where updatedAt >= fromUpdatedAt (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
Retrieve users › Responses
List of users that match the criteria
Create a user
Required scope: users:write
Organization authorization: supported
If the email or phone matches an existing Monta user, that user is linked to your application and returned with 201; the profile fields in the request are not applied to it. Use PATCH /users/{userId} to update an existing user's profile.
Create a user › Request Body
countryIdCountry Id of the user
emailEmail address of the user. Required unless phone is provided. Without an email, phone must match an existing Monta user, which is then linked to your application; a new user can't be created without an email.
phone^\+[1-9]\d{1,14}$Phone number of the user in E.164 format
firstNameFirst name of the user
lastNameLast name of the user
sendWelcomeEmailControls whether a welcome email is sent to the user after creation. For new users, the email includes a link to set their password. For existing users, the email welcomes them to the operator's platform.
languageUser preferred language
legalEmailUser legal email address
address1User address line 1
address2User address line 2
address3User address line 3
zipUser zip/postal code
cityUser city
provinceUser province/state
isEmailOrPhoneProvidedCreate a user › Responses
user with provided id
idId of the user
firstNameFirst name of the user
lastNameLast name of the user
emailEmail of the user
legalEmailLegal email of the user (certified e-mail)
phonePhone number of the user
profileImageUrlURL of the profile image
Address of the user
languagePreferred language of the user
termsReadAtTimestamp when the user read the terms
taxIdentificationNumberPersonal tax number if set for the user
vatNumberVAT number which is the company tax id
recipientCodeThe recipient code used for e-invoicing
createdAtTimestamp when the user was created
updatedAtTimestamp when the user was last updated
deletedAtTimestamp when the user was deleted
emailVerifiedAtTimestamp when the email was verified
phoneVerifiedAtTimestamp when the phone was verified
marketingEmailsAcceptedAtTimestamp when the user accepted the marketing emails
defaultTeamIdID of the default team for the user
isGuestIndicates whether this user is a guest (ad-hoc) user who has not yet completed registration
nationalIdNational identification number. Returned only when configured per operator
hasPaymentCardWhether this user has at least one saved card, including expired cards. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
hasValidPaymentCardWhether this user has at least one saved card that has not expired. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
Send the welcome email to users
Sends the welcome email to up to 100 of your users, so you can choose when they receive it. Each user is processed independently and gets its own result. A user who already got the welcome email is skipped, so a repeated or retried call never sends it twice; set force to send it again. Users that are not yours or have no email fail without affecting the others. Required scope: users:write
Organization authorization: supported
Send the welcome email to users › Request Body
Users to send the welcome email to (between 1 and 100, no duplicates)
forceSend again to users who already got the welcome email. By default they are skipped, so repeating a call is safe
Send the welcome email to users › Responses
Result per requested user
One result per requested user, in request order
Number of users per result status
Retrieve a user
Required scope: users:read
Organization authorization: supported
Optional scope: wallet-transactions:read adds hasPaymentCard and hasValidPaymentCard to the response
path Parameters
userIdRetrieve a user › Responses
user with provided id
idId of the user
firstNameFirst name of the user
lastNameLast name of the user
emailEmail of the user
legalEmailLegal email of the user (certified e-mail)
phonePhone number of the user
profileImageUrlURL of the profile image
Address of the user
languagePreferred language of the user
termsReadAtTimestamp when the user read the terms
taxIdentificationNumberPersonal tax number if set for the user
vatNumberVAT number which is the company tax id
recipientCodeThe recipient code used for e-invoicing
createdAtTimestamp when the user was created
updatedAtTimestamp when the user was last updated
deletedAtTimestamp when the user was deleted
emailVerifiedAtTimestamp when the email was verified
phoneVerifiedAtTimestamp when the phone was verified
marketingEmailsAcceptedAtTimestamp when the user accepted the marketing emails
defaultTeamIdID of the default team for the user
isGuestIndicates whether this user is a guest (ad-hoc) user who has not yet completed registration
nationalIdNational identification number. Returned only when configured per operator
hasPaymentCardWhether this user has at least one saved card, including expired cards. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
hasValidPaymentCardWhether this user has at least one saved card that has not expired. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
Update a user
Updates user information. At least one field must be provided. Required scope: users:write
Organization authorization: supported
path Parameters
userIdUpdate a user › Request Body
emailUser email address
phone^\+[1-9]\d{1,14}$User phone number in E.164 format
firstNameUser first name
lastNameUser last name
languageUser preferred language
legalEmailUser legal email address
address1User address line 1
address2User address line 2
address3User address line 3
zipUser zip/postal code
cityUser city
provinceUser province/state
marketingEmailsAcceptedSet or withdraw the user's marketing email consent for your application. false withdraws it immediately. true requests it: if your application requires double opt-in, Monta emails the user a confirmation link and marketingEmailsAcceptedAt is only set once they confirm; otherwise it is set immediately.
Update a user › Responses
User updated
idId of the user
firstNameFirst name of the user
lastNameLast name of the user
emailEmail of the user
legalEmailLegal email of the user (certified e-mail)
phonePhone number of the user
profileImageUrlURL of the profile image
Address of the user
languagePreferred language of the user
termsReadAtTimestamp when the user read the terms
taxIdentificationNumberPersonal tax number if set for the user
vatNumberVAT number which is the company tax id
recipientCodeThe recipient code used for e-invoicing
createdAtTimestamp when the user was created
updatedAtTimestamp when the user was last updated
deletedAtTimestamp when the user was deleted
emailVerifiedAtTimestamp when the email was verified
phoneVerifiedAtTimestamp when the phone was verified
marketingEmailsAcceptedAtTimestamp when the user accepted the marketing emails
defaultTeamIdID of the default team for the user
isGuestIndicates whether this user is a guest (ad-hoc) user who has not yet completed registration
nationalIdNational identification number. Returned only when configured per operator
hasPaymentCardWhether this user has at least one saved card, including expired cards. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
hasValidPaymentCardWhether this user has at least one saved card that has not expired. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
Retrieve charge-points for a user
Required scope: users:read
Organization authorization: supported
path Parameters
userIdquery Parameters
pagepage number to retrieve (starts with 0)
perPagenumber of items per page (between 1 and 100, default 10)
Retrieve charge-points for a user › Responses
List of charge-points owned by the user
Retrieve charges for a user
Required scope: users:read
Organization authorization: supported
path Parameters
userIdquery Parameters
pagepage number to retrieve (starts with 0)
perPagenumber of items per page (between 1 and 100, default 10)
Retrieve charges for a user › Responses
List of charges for the user
Update contact information for a user
Updates email and/or phone for a user. At least one field must be provided. Required scope: users:write
Organization authorization: supported
Availability: This endpoint is not available by default. It must be explicitly enabled for your operator account upon request. Please contact your Monta Business Partner to request access to this feature.
path Parameters
userIdUpdate contact information for a user › Request Body
emailUser email address
phone^\+[1-9]\d{1,14}$User phone number in E.164 format
Update contact information for a user › Responses
User contact information updated
idId of the user
firstNameFirst name of the user
lastNameLast name of the user
emailEmail of the user
legalEmailLegal email of the user (certified e-mail)
phonePhone number of the user
profileImageUrlURL of the profile image
Address of the user
languagePreferred language of the user
termsReadAtTimestamp when the user read the terms
taxIdentificationNumberPersonal tax number if set for the user
vatNumberVAT number which is the company tax id
recipientCodeThe recipient code used for e-invoicing
createdAtTimestamp when the user was created
updatedAtTimestamp when the user was last updated
deletedAtTimestamp when the user was deleted
emailVerifiedAtTimestamp when the email was verified
phoneVerifiedAtTimestamp when the phone was verified
marketingEmailsAcceptedAtTimestamp when the user accepted the marketing emails
defaultTeamIdID of the default team for the user
isGuestIndicates whether this user is a guest (ad-hoc) user who has not yet completed registration
nationalIdNational identification number. Returned only when configured per operator
hasPaymentCardWhether this user has at least one saved card, including expired cards. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
hasValidPaymentCardWhether this user has at least one saved card that has not expired. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
Set the default team for a user
Assigns an existing private team as this user's default team. The team must be owned by this user, belong to the operator (or any of its sub-operators), and not currently be another user's default. Required scope: users:write
Organization authorization: supported
path Parameters
userIdSet the default team for a user › Request Body
teamIdId of an existing private team owned by the operator (or one of its sub-operators) to assign as the user's default team
Set the default team for a user › Responses
User with default team assigned
idId of the user
firstNameFirst name of the user
lastNameLast name of the user
emailEmail of the user
legalEmailLegal email of the user (certified e-mail)
phonePhone number of the user
profileImageUrlURL of the profile image
Address of the user
languagePreferred language of the user
termsReadAtTimestamp when the user read the terms
taxIdentificationNumberPersonal tax number if set for the user
vatNumberVAT number which is the company tax id
recipientCodeThe recipient code used for e-invoicing
createdAtTimestamp when the user was created
updatedAtTimestamp when the user was last updated
deletedAtTimestamp when the user was deleted
emailVerifiedAtTimestamp when the email was verified
phoneVerifiedAtTimestamp when the phone was verified
marketingEmailsAcceptedAtTimestamp when the user accepted the marketing emails
defaultTeamIdID of the default team for the user
isGuestIndicates whether this user is a guest (ad-hoc) user who has not yet completed registration
nationalIdNational identification number. Returned only when configured per operator
hasPaymentCardWhether this user has at least one saved card, including expired cards. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
hasValidPaymentCardWhether this user has at least one saved card that has not expired. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
Retrieve teams for a user
Required scope: users:read
Organization authorization: supported
path Parameters
userIdquery Parameters
pagepage number to retrieve (starts with 0)
perPagenumber of items per page (between 1 and 100, default 10)
Retrieve teams for a user › Responses
List of teams the user belongs to