View

View information about one or more users. When authenticated as a customer you can only view users of that customer.

Tokens

This action requires the following tokens:

  • user-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
user Hash   Only show the user with the given hash.
username String   Only show the user with exactly the given username
searchfirstname String   Only show user containing the given string somewhere in the first name
searchlastname String   Only show user containing the given string somewhere in the last name
searchusername String   Only show user containing the given string somewhere in the username
searchemail String   Only show user containing the given string somewhere in the email address
email String   Only show user with the given email address
active Boolean   Only show users with this active status. If not provided, show both active and inactive users
mindatecreated DateTime   Only show users that are created on or after the given date
maxdatecreated DateTime   Only show users that are created on or before the given date
mindatemodifed DateTime   Only show users that are last modified on or after the given date
maxdatemodifed DateTime   Only show users that are last modified on or before the given date
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String created

Defines the field to order the results by; can be any of the following:

  • created – Order by date the users are created
  • modified – Order by date the users are last modified
  • username – Order lexicographically by username
  • name – Order lexicographically by full name
  • email – Order lexicographically by email address
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash User ID
username String User name
active Boolean Whether this user is active
datecreated DateTime When this user was created
datemodified DateTime When this user was last modified
email String Email address
mobilephone String Mobile phone nr
firstname String First name of the user
lastname String Last name of the user
address String Address of the user
zipcode String ZIP code of this user
city String City of this user
sessionsenabled Boolean Whether sessions are enabled for this user
timezone TimeZone Timezone for this user
customer

Customer of this user

The value of this field is an object containing the following fields:

Name Type Description
id Hash Customer ID
name String The name of this customer
datecreated DateTime When this customer was created
datemodified DateTime When this customer was last modified
singlesignontokens

Single-sign on tokens for the user

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
service

The single-sign on service for this token

The value of this field is an object containing the following fields:

Name Type Description
id Hash Single-sign on service ID
type Label The type of the single-sign service
name String The name of this service
token String The token

Errors

This action will always return one of the default status codes.