# Read a list and its entries

`GET /api/v1/ip/lists/{listId}`

- Authentication: Secret API key as a bearer token
- Billing: Free.
- Group: IP

One list with its entries in canonical form. A list that belongs to another account answers `404`.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `listId` | path | integer | yes | The list's id from the index. |

## Example request

```bash
curl https://spaw.co/api/v1/ip/lists/7 \
  -H "Authorization: Bearer sk_live_…"
```

## Responses

### 200 — The list.

```json
{
    "success": true,
    "data": {
        "list": {
            "id": 7,
            "name": "Office egress",
            "kind": "allow",
            "entry_count": 2,
            "created_at": "2026-09-12T09:00:00+00:00",
            "updated_at": "2026-09-12T09:00:00+00:00",
            "entries": [
                "203.0.113.0/24",
                "2001:db8:10::/48"
            ]
        }
    }
}
```

### 401 — The key is missing, malformed, or revoked.

```json
{
    "success": false,
    "error": {
        "code": "UNAUTHENTICATED",
        "message": "Provide a valid API key as a bearer token.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

### 404 — No such record on this account.

```json
{
    "success": false,
    "error": {
        "code": "NOT_FOUND",
        "message": "No record with that id on this account.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

### 429 — Over 5 requests per second for the key. Retry after the limit resets.

```json
{
    "success": false,
    "error": {
        "code": "RATE_LIMITED",
        "message": "Too many requests. Retry after the limit resets.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

## Error codes

- `UNAUTHENTICATED` — https://spaw.co/docs/errors/UNAUTHENTICATED
- `NOT_FOUND` — https://spaw.co/docs/errors/NOT_FOUND
- `RATE_LIMITED` — https://spaw.co/docs/errors/RATE_LIMITED

---

Canonical page: https://spaw.co/docs/api/get-ip-list · OpenAPI document: https://spaw.co/openapi.json · All endpoints: https://spaw.co/docs/api