Skip to content

Publication Citations

GET /api/html

Returns publication records as pre-rendered HTML citations.

This endpoint is intended for websites and external systems that want to display publication lists without implementing their own citation formatting.

The returned HTML is generated by OSIRIS and can be embedded directly into web pages.

Parameters

Parameter Type Description
apikey string API key, if required.
limit integer Maximum number of publications returned. Applied during retrieval, before building the response.
offset integer No effective pagination offset; ignored because the returned count is already limited.

Returned Publications

The endpoint currently returns publications matching the following criteria:

  • Activity type is publication
  • Publication year is greater than or equal to the start year (OSIRIS setting)
  • At least one author is marked as affiliated

Example Request

1
GET /api/html?apikey=YOUR_API_KEY&limit=10

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "status": 200,
  "count": 1,
  "data": [
    {
      "id": "6458fcb30d695c593828763f",
      "html": "\u003Cb\u003EKoblitz J.\u003C/b\u003E (2023) Metabolism from the magic angle. \u003Ci\u003ENature Chemical Biology\u003C/i\u003E ",
      "year": 2023,
      "departments": [
        "BID"
      ],
      "link": "https://dx.doi.org/10.1038/s41589-023-01317-2"
    }
  ]
}

Returned Fields

Field Description
id Activity ID
html Pre-rendered publication citation in HTML format
year Publication year
departments Associated departments
link DOI, PubMed, or external URL if available

The link field is automatically generated using the following priority:

  1. DOI
  2. PubMed ID
  3. External URL stored in the publication record

If none of these values are available, link is returned as null.

Typical Use Cases

  • Institutional publication lists
  • Research group websites
  • Personal profile pages
  • Public publication portals
  • Automated content integration into CMS systems

Response Behavior

count is the number of publications actually returned after applying limit, not the total number of matching publications. json, filter, columns[], and full are not supported. Department IDs are restricted to departments known to OSIRIS.