# List users `GET /api/v1/users` Lists active or deactivated workspace users. ## Permissions Send your API key in `X-API-Key`. Required permissions are **Users → Read**. ## Query parameters - `status` (string) — Use active or deactivated. Defaults to active. - `q` (string) — Search given name, family name, or email. - `length` (integer) — Number of records to return. - `start` (integer) — Zero-based offset. - `draw` (string) — Optional request marker echoed in the response. - `sort` (string) — Sort by id, firstname, surname, email, phone, roles, tsc, or tsu. Prefix the field name with a minus sign for descending order. - `order` (string) — Direction for unprefixed sort fields. Use asc or desc. ## Request Set ASDINCLOUD_API_KEY and any variables named in the example before running it. ```sh curl --get \ --url "https://api.asdincloud.com/api/v1/users" \ --header "X-API-Key: $ASDINCLOUD_API_KEY" \ --data-urlencode "status=active" \ --data-urlencode "length=25" ``` ## Response **200 OK** Returns records in `data`, the counts before and after text search, and the echoed `draw` marker. Example with fictional data and selected fields. ```json { "status": "success", "data": [ { "id": 11, "firstname": "ALEX", "surname": "EXAMPLE", "email": "alex@example.com", "phone": null, "is_active": 1, "is_owner": 0, "signup_process_completed": 0, "invited_at": null, "locale": "en", "timezone": "Europe/Rome", "deleted_at": null } ], "records_total": 1, "records_filtered": 1, "draw": null } ``` ## Errors - `401` — The API key is missing or invalid. - `403` — The API key lacks the required permission. - `422` — The status filter must be active or deactivated.