# List lists `GET /api/v1/lists` Lists list records in the workspace. ## Permissions Send your API key in `X-API-Key`. Required permissions are **Lists → Read**. ## Headers - `X-Sport-Id` (integer, required) — The sport ID from [List sports](/api/sports/list.md). Use the sport the record belongs to. ## Query parameters - `q` (string) — Search list names and descriptions. - `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, name, 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/lists" \ --header "X-API-Key: $ASDINCLOUD_API_KEY" \ --header "X-Sport-Id: ${SPORT_ID:?Set SPORT_ID}" \ --data-urlencode "length=25" \ --data-urlencode "sort=name" ``` ## 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, "sport_id": 3, "name": "Volunteer contacts", "description": "Match-day volunteers", "tsc": 1794564000, "tsu": 1794564000, "contacts_count": 1 } ], "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.