User v1.2

User provides details about the users on a Sign-Up.to account. There will always be one admin user and potentially additional sub-users.

This endpoint applies to partner-auth only. See our guide for more information on partner-auth endpoints and authentication.

This endpoint also has a company-auth version.

What can I do with user?

Create account users and retrieve various statistics and information about existing users. This can be useful for checking activity or looking up user details.

  • Only partners can create a new user with an isAdmin value of "true".
  • Please ensure you create a new admin user once an created has been created.

GET /user or /user/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the user.
active
boolNoNoWhether the user is active.
currentuser
boolYesNoWhether the user is the current user making the request.
email
stringNoNoThe user's email address.
firstname
stringNoNoThe user's first name.
isadmin
boolNoNoWhether the user is the admin user. Defaults to false.
lastlogon
int/nullNoNoTimestamp of when the user last logged into the online platform.
locked
boolNoNoBoolean (triggered by the user failing 3 login attempts in a row).
logins
intNoNoTotal number of logins the user has made.
msisdn
string/nullNoNoMobile number for the user.
password
string/nullNoNoThe user's password (at least seven characters with both letters and numbers).
lastname
stringNoNoThe user's last name (surname).
username
stringYesNoThe username for the user.
timezone
stringNoNoThe user's timezone.
cdate
decimalNoYesCreation timestamp.
mdate
decimalNoNoLast modification timestamp.

HEAD /user or /user/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the user.
currentuser
boolOptionalWhether the user is the current user making the request.
username
stringOptionalThe username for the user.

POST /user

AttributeTypePresenceDescription
active
boolOptionalWhether the user is active.
email
stringRequiredThe user's email address.
firstname
stringRequiredThe user's first name.
isadmin
boolOptional*Whether the user is the admin user. Defaults to false.
msisdn
string/nullOptionalMobile number for the user.
password
string/nullRequiredThe user's password (at least seven characters with both letters and numbers).
lastname
stringRequiredThe user's last name (surname).
username
stringRequiredThe username for the user.

The first user created must be an admin user

PUT /user or /user/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the user.
active
boolOptionalWhether the user is active.
email
stringOptionalThe user's email address.
firstname
stringOptionalThe user's first name.
msisdn
string/nullOptionalMobile number for the user.
password
string/nullOptionalThe user's password (at least seven characters with both letters and numbers).
lastname
stringOptionalThe user's last name (surname).
username
stringOptionalThe username for the user.

DELETE /user or /user/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the user.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":          12345,
    "active":      true,
    "currentuser": false,
    "email":       "jane.doe@example.com",
    "firstname":   "Jane",
    "isadmin":     false,
    "lastlogon":   133309876,
    "lastname":    "Doe",
    "locked":      false,
    "logins":      3,
    "msisdn":      "447777777777",
    "password":    "f$g5lsG5ghf!",
    "username":    "jane123",
    "timezone":    "Europe/London",
    "cdate":       1234966741,
    "mdate":       1234966741
}