Pesquisar usuários

limit required	integer Número máximo de usuários retornados por vez.
offset	integer Número dos elementos a partir dos quais a lista é gerada.
order_column	string Enum: "username" "contact" "group" "activity" "nickname" "custom_id"
order_dir	string Condition for sorting the list of users. Enum: "asc" "desc"
user_groups	Array of integers An array with user group IDs.
status	boolean Shows whether the user is active or not.
search_query	string A search query. Can be `contact`, `phone`, `id`, `social-id`, `username`, `nickname`, ot `custom_id`.
search_by	string A search criteria. Enum: "contact" "phone" "id" "social-id" "username" "nickname" "custom_id"
activity_from	string Starting date for user activity in the `YYYY-MM-DD` format.
activity_to	string Starting date for user activity in the `YYYY-MM-DD` format.

Responses

200

401

Desautorizado

404

Não encontrado

429

Pedidos demais

Request samples

curl --request GET \
  --url 'https://login.xsolla.com/api/projects/{project_id}/users/search?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&order_column=SOME_STRING_VALUE&order_dir=SOME_STRING_VALUE&user_groups=SOME_ARRAY_VALUE&status=SOME_BOOLEAN_VALUE&search_query=SOME_STRING_VALUE&search_by=SOME_STRING_VALUE&activity_from=SOME_STRING_VALUE&activity_to=SOME_STRING_VALUE' \
  --header 'X-SERVER-AUTHORIZATION: YOUR_SERVER_TOKEN'

Response samples

application/json

{"count": 0,
"next_after": 0,
"users": [{"ban": {"date_from": "string",
"date_to": "string",
"reason": "string"
},
"email": "string",
"external_id": "string",
"first_name": "string",
"groups": [{"id": 0,
"is_default": true,
"is_deletable": true,
"name": "string"
}
],
"id": "string",
"is_anonymous": true,
"is_last_email_confirmed": true,
"is_user_active": true,
"last_login": "string",
"last_name": "string",
"login_type": "string",
"name": "string",
"nickname": "string",
"phone_auth": null,
"picture": null,
"project_id": "string",
"registered": "string",
"server_custom_id": "string",
"username": "string"
}
]
}