Public Web API: Get a list of users

Request

POST /pub/v1/user/list

Request body

The resource sent in the request body is Get a list of users — Request. It contains 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	Initial index of returned items (offset)	Optional
ids[]	array of string	Filter by ID	Optional
size	int64	Number of returned items	Optional
sortExpressions[]	array	Sorting rules	Optional
sortExpressions[].ascending	boolean	Ascending sorting order 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 Model of a list of users	Model of a list of users (Get a list of users)