Help Center
Login Sign up
  1. Home
  2. API reference
  3. API documentation (JSON/XML)
  4. Tasks
  5. User tasks

User list

API reference (XML/JSON) · Updated 2023-09-19

Function

The user list task creates a list with specific user data.

Description

Route: POST ​/user​/_search

Query parameters

The following query parameters can be used to query further details:

  • language
  • owner
  • created
{
    "view": {
        "children": true
    },,
    "filters": [
        {
            "key": "authType",
            "value": "*",
            "operator": "LIKE"
        }
    ]
}
{
    "stid": "20211104-app-84047",
    "status": {
        "code": "S1301004",
        "text": "User data was inquired successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "User",
        "summary": 2
    },
    "data": [           
		{
            "created": "2021-09-15T15:56:57.000+0200",
            "context": 4,
            "defaultEmail": "customer@example.com",
            "status": 1,
            "substatus": 3,
            "authType": "ALIAS",
            "lock": "NONE",
            "user": "customer@example.com",
            "parent": {
                "created": "2021-10-06T09:31:01.000+0200",
                "context": 4,
                "status": 1,
                "substatus": 0,
                "lock": "NONE",
                "user": "customer"
            }
        },
        {
            "created": "2021-10-06T10:14:18.000+0200",
            "context": 4,
            "defaultEmail": "subcustomer@example.com",
            "status": 2,
            "substatus": 0,
            "authType": "PASSWORD",
            "lock": "NONE",
            "user": "subcustomer",
            "parent": {
                "created": "2021-10-06T09:31:01.000+0200",
                "context": 4,
                "status": 1,
                "substatus": 0,
                "lock": "NONE",
                "user": "customer"
            }
        }
	]
}