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

# List outputs

> Query and list scholarly works with filtering, sorting, and pagination.

Retrieves a paginated list of scholarly outputs with filtering and sorting capabilities.

### Query Parameters

<ParamField query="page" default="1" type="integer">
  Page number for pagination. Default is `1`.
</ParamField>

<ParamField query="per_page" default="25" type="integer">
  Results per page. Allowed values: `10`, `25`, `50`, `100`.
</ParamField>

<ParamField query="filter" type="string">
  Filter expression (e.g. `year:2025`, `is_oa:true`).
</ParamField>

<ParamField query="sort" type="string">
  Sorting parameter (e.g. `cited_by_count:desc`, `year:asc`).
</ParamField>

### Response Fields

<ResponseField name="meta" type="object" required>
  Pagination and execution metadata.

  <Expandable title="meta attributes">
    <ResponseField name="count" type="integer">Total matching records count.</ResponseField>
    <ResponseField name="page" type="integer">Current page number.</ResponseField>
    <ResponseField name="per_page" type="integer">Requested items per page.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="results" type="array" required>
  Array of output records.

  <Expandable title="results item attributes">
    <ResponseField name="id" type="string">Output ID (`HX_W...`).</ResponseField>
    <ResponseField name="doi" type="string">DOI URL.</ResponseField>
    <ResponseField name="title" type="string">Work title.</ResponseField>
    <ResponseField name="name" type="string">Work display name.</ResponseField>
    <ResponseField name="year" type="integer">Publication year.</ResponseField>
    <ResponseField name="date" type="string">Publication date (YYYY-MM-DD).</ResponseField>
    <ResponseField name="language" type="string">Language code string (e.g. `"en"`).</ResponseField>
    <ResponseField name="venue" type="object">Primary venue details (`id`, `is_oa`, `landing_page_url`, `pdf_url`, `license`, `version`, `is_accepted`, `is_published`, `source`).</ResponseField>
    <ResponseField name="type" type="string">Work classification (`article`, `preprint`, etc.).</ResponseField>
    <ResponseField name="indexed_in" type="array">Index providers array (e.g. `["crossref"]`).</ResponseField>
    <ResponseField name="open_access" type="object">Open Access object (`is_oa`, `oa_status`, `oa_url`).</ResponseField>
    <ResponseField name="authors" type="array">List of author name strings.</ResponseField>
    <ResponseField name="affiliations" type="array">List of unique institution name strings.</ResponseField>
    <ResponseField name="fwci" type="number">Field-Weighted Citation Impact.</ResponseField>
    <ResponseField name="cited_by_count" type="integer">Citation count.</ResponseField>
    <ResponseField name="biblio" type="object">Bibliographic details (`volume`, `issue`, `first_page`, `last_page`).</ResponseField>
    <ResponseField name="primary_topic" type="object">Primary topic object (`id`, `name`).</ResponseField>
    <ResponseField name="keywords" type="array">Keywords array.</ResponseField>
    <ResponseField name="abstract" type="string">Abstract text snippet.</ResponseField>
    <ResponseField name="updated_date" type="string">ISO updated date string.</ResponseField>
    <ResponseField name="created_date" type="string">ISO creation date string.</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.hexagraph.in/outputs?filter=year:2020&sort=cited_by_count:desc&per_page=25"
  ```

  ```javascript JavaScript theme={null}
  fetch("https://api.hexagraph.in/outputs?filter=year:2020&sort=cited_by_count:desc&per_page=25")
    .then(response => response.json())
    .then(data => console.log(data));
  ```

  ```python Python theme={null}
  import requests

  response = requests.get("https://api.hexagraph.in/outputs", params={
      "filter": "year:2020",
      "sort": "cited_by_count:desc",
      "per_page": 25
  })
  print(response.json())
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "meta": {
      "count": 322998529,
      "page": 1,
      "per_page": 25
    },
    "results": [
      {
        "id": "HX_W3038568908",
        "doi": "https://doi.org/10.1585/pfr.15.2402039",
        "title": "Radiation Resistant Camera System for Monitoring Deuterium Plasma Discharges in the Large Helical Device",
        "name": "Radiation Resistant Camera System for Monitoring Deuterium Plasma Discharges in the Large Helical Device",
        "year": 2020,
        "date": "2020-06-08",
        "language": "en",
        "venue": {
          "id": "doi:10.1585/pfr.15.2402039",
          "is_oa": true,
          "landing_page_url": "https://doi.org/10.1585/pfr.15.2402039",
          "pdf_url": "https://www.jstage.jst.go.jp/article/pfr/15/0/15_2402039/_pdf",
          "license": null,
          "version": "publishedVersion",
          "is_accepted": true,
          "is_published": true,
          "source": {
            "id": "HX_S46033839",
            "name": "Plasma and Fusion Research",
            "type": "journal",
            "metrics": null
          }
        },
        "type": "article",
        "indexed_in": [
          "crossref"
        ],
        "open_access": {
          "is_oa": true,
          "oa_status": "diamond",
          "oa_url": "https://www.jstage.jst.go.jp/article/pfr/15/0/15_2402039/_pdf"
        },
        "authors": [
          "M. Shoji",
          "LHD Experiment Group"
        ],
        "affiliations": [
          "National Institutes of Natural Sciences",
          "National Institute for Fusion Science"
        ],
        "fwci": 0.9171,
        "cited_by_count": 801217,
        "biblio": {
          "volume": "15",
          "issue": "0",
          "first_page": "2402039",
          "last_page": "2402039"
        },
        "primary_topic": {
          "id": "HX_T10346",
          "name": "Magnetic confinement fusion research"
        },
        "keywords": [
          "Radiation",
          "Plasma",
          "Materials science",
          "Optics",
          "Shield",
          "Neutron",
          "Nuclear engineering",
          "Physics",
          "Nuclear physics",
          "Geology"
        ],
        "abstract": "Radiation resistant camera system was constructed for monitoring deuterium plasma discharges in the Large Helical Device (LHD). This system has contributed to safe operation during two experimental campaigns without serious problems due to radiation (neutrons and gamma-rays). The cameras steadily functioned even in the plasma discharge with the maximum neutron emission rate in FY 2017, though some bright specks temporarily appeared on the images.",
        "updated_date": "2026-07-22T07:51:19.307946",
        "created_date": "2025-10-10T00:00:00"
      }
    ]
  }
  ```

  ```json 400 Bad Request theme={null}
  {
    "statusCode": 400,
    "message": "Bad Request - Invalid query parameters",
    "error": "Bad Request"
  }
  ```

  ```json 429 Rate Limit Exceeded theme={null}
  {
    "statusCode": 429,
    "message": "Rate limit exceeded. Maximum 30 requests per minute.",
    "error": "Too Many Requests"
  }
  ```
</ResponseExample>