# List suppliers `GET /api/v1/suppliers` Lists supplier records in the workspace. ## Permissions Send your API key in `X-API-Key`. Required permissions are **Suppliers → Read**. ## Query parameters - `q` (string) — Search by name, email, VAT number, or tax code. - `is_active` (integer) — Use 1 for active or 0 for inactive. - `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, email, city, is_active, 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/suppliers" \ --header "X-API-Key: $ASDINCLOUD_API_KEY" \ --data-urlencode "length=10" ``` ## Response **200 OK** Returns items in `data`, counts before and after text search, and the optional `draw` marker. Example with fictional data and selected fields. ```json { "status": "success", "data": [ { "id": 8, "name": "Example Sports Supplies", "email": "orders@example.com", "is_active": true } ], "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.