---
title: "User list"
url: "https://help.internetx.com/en/api/core-user-list/"
lang: "en"
section: "API reference — API reference (XML/JSON)"
breadcrumb: "API documentation (JSON/XML) > Tasks > User tasks"
updated: "2023-09-19"
---

# User list

## 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"
            }
        }
	]
}
```

Task code: 1301004  
Uses [User](/en/api/core-user-object/) object

### Keywords

The following keywords are returned by default:

-   context
-   default\_mail
-   status
-   substatus
-   user
-   auth\_type
-   lock

The data of the following keywords can be queried with the <key> keyword:

-   language
-   owner
-   uid
-   created

```
<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context>104</context>
	</auth>
	<task>
		<code>1301004</code>
		<view>
			<limit>2</limit>
			<children>0</children>
			<offset>1</offset>
		</view>
		<key>uid</key>
		<key>owner</key>
		<key>language</key>
		<key>created</key> 
	</task>
</request>
```

```
<response>
    <result>
        <data>
            <summary>2</summary>         
            <user>
                <parent>939870</parent>
                <default_mail>customer@example.com</default_mail>
                <language>de</language>
                <status>1</status>
                <substatus>3</substatus>
                <uid>939444</uid>
                <lock>NONE</lock>
                <created>2021-09-15 15:56:57</created>
                <user>customer@example.com</user>
                <context>4</context>
                <auth_type>ALIAS</auth_type>
            </user>
            <user>
                <parent>939870</parent>
                <default_mail>subcustomer@example.com</default_mail>
                <language>de</language>
                <status>2</status>
                <substatus>0</substatus>
                <uid>939872</uid>
                <lock>NONE</lock>
                <created>2021-10-06 10:14:18</created>
                <user>subcustomer</user>
                <context>4</context>
                <auth_type>PASSWORD</auth_type>
            </user>
        </data>
        <status>
            <code>S1301004</code>
            <text>User data was inquired successfully.</text>
            <type>success</type>
        </status>
    </result>
    <stid>20211104-app-6288</stid>
</response>
```