> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allium.so/llms.txt
> Use this file to discover all available pages before exploring further.

# List entries

> Returns a paginated list of values in a dataset.

Returns a paginated list of values in the dataset, sorted alphabetically.

**Path parameters:**

| Parameter    | Description |
| :----------- | :---------- |
| `dataset_id` | Dataset ID  |

**Query parameters:**

| Parameter | Default | Description                                |
| :-------- | :------ | :----------------------------------------- |
| `cursor`  | `null`  | Pagination cursor from a previous response |
| `limit`   | `10000` | Number of values per page (1-500,000)      |

```bash theme={null}
curl -X GET "https://api.allium.so/api/v1/beam/datasets/${DATASET_ID}/entries?limit=10000" \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
```

**Response:**

```json theme={null}
{
  "values": ["0x3c499c542cef5e3811e1192ce70d8cc03d5c3359", "0xc2132d05d31c914a87c6611c10748aeb04b58e8f"],
  "cursor": "0xc2132d05d31c914a87c6611c10748aeb04b58e8f",
  "total_count": 1500
}
```

| Field         | Description                                       |
| :------------ | :------------------------------------------------ |
| `values`      | Array of values in the current page               |
| `cursor`      | Cursor for the next page, `null` if no more pages |
| `total_count` | Total number of values in the dataset             |

## Retrieving all entries

Use the `cursor` field to paginate through the full dataset:

```python theme={null}
import httpx

PAGE_SIZE = 500_000

def list_all_entries(dataset_id: str, api_key: str) -> list[str]:
    all_values = []
    cursor = None

    with httpx.Client(headers={"X-API-Key": api_key}) as client:
        while True:
            params = {"limit": PAGE_SIZE}
            if cursor:
                params["cursor"] = cursor

            resp = client.get(
                f"https://api.allium.so/api/v1/beam/datasets/{dataset_id}/entries",
                params=params,
            )
            resp.raise_for_status()
            data = resp.json()

            all_values.extend(data["values"])
            cursor = data.get("cursor")

            if not cursor:
                break

    return all_values
```


## OpenAPI

````yaml _openapi/beam-api.json GET /api/v1/beam/datasets/{dataset_id}/entries
openapi: 3.1.0
info:
  title: Allium Beam API
  description: Allium Beam — managed streaming pipelines on top of Allium Datastreams.
  version: 1.0.0
servers:
  - url: https://api.allium.so
security: []
paths:
  /api/v1/beam/datasets/{dataset_id}/entries:
    get:
      tags:
        - BEAM
      summary: List Entries Handler
      operationId: list_entries_handler_api_v1_beam_datasets__dataset_id__entries_get
      parameters:
        - name: dataset_id
          in: path
          required: true
          schema:
            type: string
            title: Dataset Id
        - name: cursor
          in: query
          required: false
          schema:
            title: Cursor
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500000
            minimum: 1
            default: 10000
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetEntriesListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyBearer: []
components:
  schemas:
    DatasetEntriesListResponse:
      properties:
        values:
          items:
            type: string
          type: array
          title: Values
        cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Cursor
        total_count:
          type: integer
          title: Total Count
      type: object
      required:
        - values
        - cursor
        - total_count
      title: DatasetEntriesListResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyBearer:
      type: apiKey
      in: header
      name: X-API-KEY

````