Skip to main content
GET
List users
Use this endpoint to list every user you’ve created in the MX Platform API.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

page
integer

Results are paginated. Specify current page.

records_per_page
integer

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

id
string

The user id to search for.

email
string

The user email to search for.

is_disabled
boolean

Search for users that are disabled.

Response

200 - application/vnd.mx.api.v1+json

OK

users
object[]
pagination
object