# List directors `GET /api/v1/directors` Lists director records in the workspace. ## Permissions Send your API key in `X-API-Key`. Required permissions are **Directors → Read**. ## Query parameters - `archived` (boolean) — Use true for archived directors. Defaults to false. - `team_id` (integer) — Include directors assigned to this team. - `exclude_team_id` (integer) — Exclude directors assigned to this team. - `q` (string) — Search by name, email, or tax code. - `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, 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/directors" \ --header "X-API-Key: $ASDINCLOUD_API_KEY" \ --data-urlencode "length=25" \ --data-urlencode "archived=false" ``` ## 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": 12, "firstname": "ALEX", "surname": "EXAMPLE", "type": "staff", "sport_id": null, "email": "alex@example.com", "archived_at": null, "to_notify": false, "metadata": { "domain": "operations" }, "fullname": "EXAMPLE ALEX" } ], "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.