Management v1 - Get a list of users

Query parameters

Required Optional

username string

The partial or complete username to select all users that match.

pageSize integer

The number of items to have on a page. Maximum value is 100. The default is 10 items on a page.

pageNumber integer

The number of the page to fetch.

Path parameters

Required Optional

merchantId string Required

Unique identifier of the merchant.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
_links object

Pagination references.

Show children Hide children

first object

The first page.

Show children Hide children

href string

last object

The last page.

Show children Hide children

href string

next object

The next page. Only present if there is a next page.

Show children Hide children

href string

prev object

The previous page. Only present if there is a previous page.

Show children Hide children

href string

self object

The current page.

Show children Hide children

href string

data array [object]

The list of users.

Show children Hide children

_links object

References to resources connected with this user.

Show children Hide children

self object

Link to the resource itself.

Show children Hide children

href string

accountGroups array [string]

The list of account groups associated with this user.

active boolean

Indicates whether this user is active.

email string

The email address of the user.

id string

The unique identifier of the user.

name object

The user's full name.

Show children Hide children

firstName string

The first name.

lastName string

The last name.

roles array [string]

The list of roles for this user.

timeZoneCode string

The tz database name of the time zone of the user. For example, Europe/Amsterdam.

username string

Min length: 1 Max length: 255

The username for this user.

itemsTotal integer

Total number of items.

pagesTotal integer

Total number of pages.
204 - No Content

The request has been successfully processed, but there is no additional content.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized

Authentication required.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity

A request validation error.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error

The server could not process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get a list of users

Endpoint destination URL

Query parameters

Path parameters

Response parameters

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error