Public Web API: Get a list of users

Request

POST /pub/v1/user/list

Request body

The request body takes a complete resource Get a list of users - Request. Containing the following writable properties:

{
    "filter": {
        "<key>": {}
    },
    "from": "int64",
    "ids": [
        "string"
    ],
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ]
}

Properties

Name	Type	Description	Additional
filter	object	Filter	Optional.
filter.<key>	map of object		Optional.
from	int64	Offset of the returned items.	Optional.
ids[]	array of string	Filter by ID	Optional.
size	int64	Number of returned items (100 max)	Optional.
sortExpressions[]	array	Sorting rules	Optional.
sortExpressions[].ascending	boolean	Sort ascending flag	Optional.
sortExpressions[].field	string	Sort field	Optional.

Authorization

This request requires the use of one of following authorisation methods: API key

Response

The following HTTP status codes may be returned.

Status code	Description	Resource
200	OK User search model.	User search model (Get a list of users)