User Endpoint | Sign-Up.to Permission Marketing API

User v1.2

User provides details about the users on your Sign-Up.to account. You will always have one admin user and potentially additional sub-users.

This endpoint also has a partner-auth version.

What can I do with user?

Retrieve various statistics and information on your account users. This can be useful for checking activity or looking up user details.

Look up a user's lastlogon to find out the last time they accessed the account.
Find a user's contact and personal details filtering by currentuser or username.
The currentuser attribute can be useful for ascertaining the authenticated user's isadmin status.
Find out if the user is locked out of an account (through failed login attempts) using locked.

In all cases, a user's password is write-only. The attribute will be returned as "null".

GET /user or /user/:id

Attribute	Type	Filter	Sort	Description
id	int	Yes	Yes	Unique ID of the user.
active	bool	No	No	Whether the user is active.
currentuser	bool	Yes	No	Whether the user is the current user making the request.
email	string	No	No	The user's email address.
firstname	string	No	No	The user's first name.
isadmin	bool	No	No	Whether the user is the admin user.
lastlogon	int/null	No	No	Timestamp of when the user last logged into the online platform.
locked	bool	No	No	Boolean (triggered by the user failing 3 login attempts in a row).
logins	int	No	No	Total number of logins the user has made.
msisdn	string/null	No	No	Mobile number for the user.
password	string/null	No	No	The user's password (at least seven characters with both letters and numbers).
lastname	string	No	No	The user's last name (surname).
username	string	Yes	No	The username for the user.
timezone	string	No	No	The user's timezone.
cdate	decimal	No	Yes	Creation timestamp.
mdate	decimal	No	No	Last modification timestamp.

Admin users can access all user data. Sub-users are only permitted to retrieve their own user data.

HEAD /user or /user/:id

Attribute	Type	Presence	Description
id	int	Optional	Unique ID of the user.
currentuser	bool	Optional	Whether the user is the current user making the request.
username	string	Optional	The username for the user.

POST /user

Attribute	Type	Presence	Description
active	bool	Optional	Whether the user is active.
email	string	Required	The user's email address.
firstname	string	Required	The user's first name.
msisdn	string/null	Optional	Mobile number for the user.
password	string/null	Required	The user's password (at least seven characters with both letters and numbers).
lastname	string	Required	The user's last name (surname).
username	string	Required	The username for the user.

Admin users can create new users.

PUT /user or /user/:id

Attribute	Type	Presence	Description
id	int	Required	Unique ID of the user.
active	bool	Optional	Whether the user is active.
email	string	Optional	The user's email address.
firstname	string	Optional	The user's first name.
msisdn	string/null	Optional	Mobile number for the user.
password	string/null	Optional	The user's password (at least seven characters with both letters and numbers).
lastname	string	Optional	The user's last name (surname).
username	string	Optional	The username for the user.

Admin users can modify other users. Sub-users are only permitted to modify their own user data.

DELETE /user or /user/:id

Attribute	Type	Presence	Description
id	int	Required	Unique ID of the user.

Admin users can remove other users, but not themselves.

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
}