# List hosts (/docs/api-reference/scheduling-hosts/list-scheduling-hosts)

The environment's hosts, newest first.

`GET https://api.coss.com/v1/scheduling/hosts`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Query parameters

- `limit` (integer, 1-100, default 20)
- `after` (string): The last id of the previous page.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.scheduling.hosts.list();
```

HTTP:

```sh
curl -X GET "https://api.coss.com/v1/scheduling/hosts" \
  -H "Authorization: Bearer $COSS_API_KEY"
```

## Response 200

A page of hosts.

- `object` ("list", required)
- `data` (object[], required)
  - `object` ("scheduling.host", required)
  - `id` (string, required)
  - `uid` (string | null, required)
  - `name` (string, required)
  - `email` (string | null, required)
  - `time_zone` (string, required)
  - `attributes` (map of string | string[], required)
  - `metadata` (map of string, required)
  - `status` ("active" | "disabled", required)
  - `created_at` (string, required)
  - `updated_at` (string, required)
- `has_more` (boolean, required)

Example:

```json
{
  "object": "list",
  "data": [
    {
      "object": "scheduling.host",
      "id": "host_01kd2m9a0b1c2d3e4f5g6h7j8m",
      "uid": "doctor_482",
      "name": "Dr. Ana Reyes",
      "email": "ana@example.com",
      "time_zone": "America/New_York",
      "attributes": {
        "licensed_in": [
          "NY",
          "NJ"
        ]
      },
      "metadata": {},
      "status": "active",
      "created_at": "2027-01-01T10:00:00.000Z",
      "updated_at": "2027-01-01T10:00:00.000Z"
    }
  ],
  "has_more": false
}
```

## Errors

- `400`: The `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `422`: The request failed validation (`validation_error`, see `issues`), or can't be done: see `code`.
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).