# HAL

> Search HAL, France's national open archive of scholarly work, for articles, preprints, theses, conference papers and reports by words, author, lab, institution, domain, journal, funding project and date, with their abstracts, DOIs and free PDF links. Count a lab's or an author's output by year or type, export citations as BibTeX, look up authors, labs, journals and ANR or European projects, and start a workflow when a new document matches. No account or API key required.

App · 13 actions. Web page: https://docs.lodol.com/docs/integrations/hal

## Actions

### Count documents

Count the documents on HAL that match, grouped by year, type, domain, language, journal, lab, institution, author, keyword, collection, portal or availability, such as a lab's publications a year or an author's most frequent co-authors. Takes the same filters as 'Search documents'.

**Inputs**

- Count by (`group_by`, text, required): What to group the documents by. One of: `produced_year` (Year produced), `deposit_year` (Year deposited), `doc_type` (Document type), `domain` (Scientific domain), `language`, `journal`, `lab` (Laboratory), `institution`, `author`, `keyword`, and 3 more.
- Search text (`query`, text): Words to look for, all of them by default. Put a phrase in double quotes to match it exactly; OR between words matches either. Leave empty to filter with the other fields alone.
- Search in (`search_in`, text): Where the search text must appear. Everywhere covers titles, abstracts, keywords, authors, journals and more; the full text searches inside the files deposited on HAL. One of: `text` (Everywhere (titles, abstracts, keywords, authors and more)), `title` (Titles), `abstract` (Abstracts), `keywords`, `fulltext` (Full text of the deposited files). Default: `text`.
- Authors (`authors`, text): Only documents by any of these authors: an idHAL, an ORCID, or an author ID from 'Search authors', one per line or separated by commas.
- Author name (`author_name`, text): Only documents with an author of this name as written on them, in either order. 'Authors' is more precise when the author has an idHAL or an ORCID.
- Structures (`structures`, text): Only documents from any of these labs, teams or institutions (an institution includes its labs): a structure ID from 'Search structures', a ROR ID or an RNSR number, one per line or separated by commas.
- Collection (`collection`, text): Only documents in this HAL collection (a lab's, a project's or a conference's publication list), by its code: the part after hal.science/ in the collection's address.
- Portal (`portal`, text): Only what one HAL portal shows, such as TEL (every thesis) or a university's or institute's own archive. Leave empty for all of HAL.
- Document types (`doc_types`, list): Only documents of any of these types, such as journal articles, theses or preprints. Leave empty for every type.
- Scientific domains (`domains`, list): Only documents in any of these domains. A domain includes its subdomains. Leave empty for every domain.
- Languages (`languages`, list): Only documents written in any of these languages. Leave empty for every language.
- Journal (`journal`, text): Only articles in this journal: its ID from 'Search journals', or its ISSN.
- Funding project (`project`, text): Only documents that acknowledge this project: an ANR reference or a European grant number, as 'Search ANR projects' and 'Search European projects' give them.
- Deposited on or after (`submitted_after`, date): Only documents deposited on HAL on this day or later, in French time.
- Deposited on or before (`submitted_before`, date): Only documents deposited on HAL on this day or earlier.
- Produced on or after (`produced_after`, date): Only documents written or published on this day or later. One dated only by its year counts as 1 January.
- Produced on or before (`produced_before`, date): Only documents written or published on this day or earlier.
- Availability (`availability`, text): Only documents anyone can read for free (on HAL, or elsewhere such as arXiv or the publisher), or only those whose full text is on HAL. One of: `any` (Any document), `open_access` (Free to read, on HAL or elsewhere), `full_text` (With its full text on HAL). Default: `any`.
- Peer reviewed only (`peer_reviewed`, true/false): Only documents reviewed by a committee before publication. Default: `false`.
- Order of groups (`group_order`, text): The groups with the most documents first, or in order. By default years come in order (the latest ones, earliest first) and everything else by size. Journals, labs and institutions only come by size. One of: `count` (Most documents first), `value` (In order: A to Z, or the latest years, earliest first).
- How many groups (`limit`, number): How many groups to return, up to 500. From 1 to 500. Default: `20`.

**Outputs**

- `count` (number): How many groups are listed.
- `group_by` (text): What the documents were counted by.
- `groups` (list): The groups, with how many documents each holds.
- `total` (number): How many documents match, in all groups together.

**Example output**

```json
{
  "count": 3,
  "group_by": "doc_type",
  "groups": [
    {
      "count": 4933,
      "label": "Conference papers",
      "value": "COMM"
    },
    {
      "count": 2218,
      "label": "Journal articles",
      "value": "ART"
    },
    {
      "count": 758,
      "label": "Theses",
      "value": "THESE"
    }
  ],
  "total": 9953
}
```

### Export citations

Get citations for up to 100 documents on HAL as BibTeX or EndNote for a reference manager, or as plain text, each document's own and all of them together, such as a lab's publication list for a web page.

**Inputs**

- Documents (`documents`, text, required): Up to 100 HAL IDs or links, one per line or separated by commas, or a list from 'Search documents'.
- Format (`citation_format`, text): The citation format. One of: `bibtex`, `endnote`, `text` (Plain text citation). Default: `bibtex`.

**Outputs**

- `citation_format` (text): The format: bibtex, endnote or text.
- `citations` (list): Each document's citation, in the order asked for.
- `count` (number): How many citations were found.
- `not_found` (list): The HAL IDs HAL has no document for.
- `text` (text): Every citation one after another, ready to paste into a reference manager or a page.

**Example output**

```json
{
  "citation_format": "bibtex",
  "citations": [
    {
      "citation": "@article{grohmann:hal-05837653,\n  TITLE = {{The 10 billion travel world: Continuity and change in global transnational mobility (1995--2022)}},\n  AUTHOR = {Grohmann, Tobias and Recchi, Ettore and Bernasconi, Luca},\n  URL = {https://sciencespo.hal.science/hal-05837653},\n  JOURNAL = {{Data \\& Policy}},\n  PUBLISHER = {{University of Cambridge Press}},\n  VOLUME = {8},\n  YEAR = {2026},\n  DOI = {10.1017/dap.2026.10102},\n  KEYWORDS = {human mobility ; migration ; tourism ; transnationalism},\n  PDF = {https://sciencespo.hal.science/hal-05837653v1/file/the-10-billion-travel-world-continuity-and-change-in-global-transnational-mobility-1995-2022.pdf},\n  HAL_ID = {hal-05837653},\n  HAL_VERSION = {v1},\n}",
      "hal_id": "hal-05837653"
    }
  ],
  "count": 1,
  "not_found": [
    "hal-00000000"
  ],
  "text": "@article{grohmann:hal-05837653,\n  TITLE = {{The 10 billion travel world: Continuity and change in global transnational mobility (1995--2022)}},\n  AUTHOR = {Grohmann, Tobias and Recchi, Ettore and Bernasconi, Luca},\n  URL = {https://sciencespo.hal.science/hal-05837653},\n  JOURNAL = {{Data \\& Policy}},\n  PUBLISHER = {{University of Cambridge Press}},\n  VOLUME = {8},\n  YEAR = {2026},\n  DOI = {10.1017/dap.2026.10102},\n  KEYWORDS = {human mobility ; migration ; tourism ; transnationalism},\n  PDF = {https://sciencespo.hal.science/hal-05837653v1/file/the-10-billion-travel-world-continuity-and-change-in-global-transnational-mobility-1995-2022.pdf},\n  HAL_ID = {hal-05837653},\n  HAL_VERSION = {v1},\n}"
}
```

### Find a document by DOI or another ID

Find the documents on HAL with a DOI, an arXiv ID, a PubMed or PubMed Central ID, a French thesis number (NNT) or a HAL ID, with everything 'Get a document' gives, such as to check whether a paper is deposited and get its free copy. 'Found' is false when HAL has none.

**Inputs**

- ID (`identifier`, text, required): The ID in any common form: a DOI or doi.org link, an arXiv ID or link, a PubMed ID, a PMC ID, a thesis number such as 2020TOU30066, or a HAL ID.
- Kind of ID (`id_type`, text): Which registry the ID is from. Worked out from its shape by default. One of: `auto` (Work it out from the ID), `doi`, `hal` (HAL ID), `arxiv` (arXiv ID), `pubmed` (PubMed ID), `pmc` (PubMed Central ID), `nnt` (French thesis number (NNT)). Default: `auto`.

**Outputs**

- `count` (number): How many documents carry it (more than one when HAL holds duplicates).
- `documents` (list): The documents found.
- `found` (true/false): Whether HAL has a document with this ID.
- `id_type` (text): What kind of ID it is: doi, hal, arxiv, pubmed, pmc or nnt.
- `identifier` (text): The ID looked for, as HAL stores it.

**Example output**

```json
{
  "count": 1,
  "documents": [
    {
      "abstract": "Notwithstanding its size and importance in a globalized world, there is little systematic information about the volume and direction of human travel that considers both migration and other kinds of mobility. This...",
      "anr_projects": [],
      "arxiv_id": null,
      "author_names": [
        "Tobias Grohmann",
        "Ettore Recchi"
      ],
      "author_orcids": [
        "0000-0002-3051-1165",
        "0000-0001-7497-2150"
      ],
      "authors": [
        {
          "affiliations": [
            "European University Institute - Institut Universitaire Europ\u00e9en"
          ],
          "author_id": "3600618-1555182",
          "idhal": null,
          "name": "Tobias Grohmann"
        },
        {
          "affiliations": [
            "Centre de recherche sur les in\u00e9galit\u00e9s sociales (Sciences Po, CNRS)"
          ],
          "author_id": "849755-993811",
          "idhal": "ettore-recchi",
          "name": "Ettore Recchi"
        }
      ],
      "book_title": null,
      "citation": "Tobias Grohmann, Ettore Recchi, Luca Bernasconi. The 10 billion travel world: Continuity and change in global transnational mobility (1995\u20132022). Data & Policy, 2026, 8, \u27e810.1017/dap.2026.10102\u27e9. \u27e8hal-05837653\u27e9",
      "collections": [
        {
          "code": "SHS",
          "name": "Sciences de l'Homme et de la Soci\u00e9t\u00e9"
        },
        {
          "code": "SCIENCESPO",
          "name": "Sciences Po"
        }
      ],
      "conference": null,
      "doc_subtype": "DATAPAPER",
      "doc_type": "ART",
      "doc_type_label": "Journal articles",
      "doi": "10.1017/dap.2026.10102",
      "doi_url": "https://doi.org/10.1017/dap.2026.10102",
      "domains": [
        {
          "code": "shs.socio",
          "label": "Humanities and Social Sciences/Sociology"
        }
      ],
      "european_projects": [],
      "files": [
        "https://sciencespo.hal.science/hal-05837653/file/the-10-billion-travel-world-continuity-and-change-in-global-transnational-mobility-1995-2022.pdf"
      ],
      "full_text_on_hal": true,
      "hal_id": "hal-05837653",
      "issue": null,
      "journal": "Data & Policy",
      "journal_id": 171628,
      "journal_issn": "2632-3249",
      "keywords": [
        "Human mobility",
        "Migration",
        "Tourism",
        "Transnationalism"
      ],
      "language": "en",
      "licence": "https://creativecommons.org/licenses/by/4.0/",
      "modified_at": "2026-10-24T03:04:07+02:00",
      "open_access": true,
      "open_access_url": "https://sciencespo.hal.science/hal-05837653/document",
      "pages": null,
      "pdf_url": "https://sciencespo.hal.science/hal-05837653/document",
      "portal": "sciencespo",
      "produced_date": "2026",
      "publication_date": "2026",
      "publisher": "University of Cambridge Press",
      "pubmed_id": null,
      "released_at": "2026-10-23T19:36:06+02:00",
      "structures": [
        {
          "id": 1140212,
          "name": "Centre de recherche sur les in\u00e9galit\u00e9s sociales (Sciences Po, CNRS)",
          "type": "laboratory"
        },
        {
          "id": 169834,
          "name": "European University Institute - Institut Universitaire Europ\u00e9en",
          "type": "institution"
        },
        {
          "id": 301587,
          "name": "Sciences Po",
          "type": "institution"
        }
      ],
      "submitted_at": "2026-10-23T19:34:53+02:00",
      "subtitle": null,
      "title": "The 10 billion travel world: Continuity and change in global transnational mobility (1995\u20132022)",
      "url": "https://sciencespo.hal.science/hal-05837653",
      "version": 1,
      "volume": "8"
    }
  ],
  "found": true,
  "id_type": "doi",
  "identifier": "10.1017/dap.2026.10102"
}
```

### Get a document

Get one document on HAL by its HAL ID or link: its title, authors with their idHAL and affiliations, abstract, keywords, DOI, type, domains, journal or conference, dates, licence, PDF and file links, structures, collections and funding projects.

**Inputs**

- Document (`document`, text, required): The document's HAL ID, with or without its version, or its link. 'Search documents' gives it.

**Outputs**

- `abstract` (text): Its abstract, in the first language given.
- `anr_projects` (list): The French National Research Agency (ANR) projects it acknowledges, by reference, such as 'ANR-23-IACL-0007'.
- `arxiv_id` (text): Its arXiv ID, such as '2506.01476', when it is on arXiv.
- `author_names` (list): The authors' names alone, in order.
- `author_orcids` (list): The ORCID iDs the document gives for its authors, such as '0000-0002-0756-0508'.
- `authors` (list): Its authors in the order the document lists them.
- `book_title` (text): The book, for a book chapter.
- `citation` (text): A ready-made citation in plain text, as HAL writes it under the title.
- `collections` (list): The HAL collections it is in (a lab's or a project's publication list).
- `conference` (text): The conference, for a conference paper or poster.
- `doc_subtype` (text): A finer kind, when there is one, such as PREPRINT, ARTREV (review article) or RESREPORT (research report).
- `doc_type` (text): HAL's code for the kind of document, such as ART (journal article), COMM (conference paper), THESE (thesis) or UNDEFINED (preprint).
- `doc_type_label` (text): The kind of document in words, such as 'Theses'.
- `doi` (text): Its DOI, such as '10.1017/dap.2026.10102', when it has one.
- `doi_url` (text): Its DOI as a link.
- `domains` (list): Its scientific domains.
- `european_projects` (list): The European projects it acknowledges, by grant number, such as '101087830'.
- `files` (list): Links to every file deposited with it.
- `full_text_on_hal` (true/false): Whether HAL holds its full text.
- `hal_id` (text): The document's HAL ID, such as 'hal-05837744'. 'Get a document' and 'Export citations' take it.
- `issue` (text): The journal issue.
- `journal` (text): The journal it was published in, for an article.
- `journal_id` (number): HAL's ID for that journal: 'Journal' in 'Search documents' takes it.
- `journal_issn` (text): The journal's ISSN (or electronic ISSN).
- `keywords` (list): Its keywords.
- `language` (text): The language it is written in, as a code such as 'en'.
- `licence` (text): The licence it is shared under, such as a Creative Commons link.
- `modified_at` (text): When its record last changed, in French time.
- `open_access` (true/false): Whether it is free to read, on HAL or elsewhere.
- `open_access_url` (text): The best link to read it for free: the file on HAL, or a free copy elsewhere (arXiv, the publisher).
- `pages` (text): The pages, such as '80-89'.
- `pdf_url` (text): A link to its main file on HAL (usually a PDF), when HAL holds it.
- `portal` (text): The portal it was deposited through, such as 'hal', 'tel' or 'inria'.
- `produced_date` (text): When the work was written or published, as precise as the depositor gave it: '2026', '2026-10' or '2026-10-06'.
- `publication_date` (text): When it was published, when HAL records it.
- `publisher` (text): The journal's publisher.
- `pubmed_id` (text): Its PubMed ID, when it is in PubMed.
- `released_at` (text): When it went online on HAL, after moderation, in French time with its offset.
- `structures` (list): Every structure the document is linked to, from research teams to institutions.
- `submitted_at` (text): When it was deposited on HAL, in French time with its offset, such as '2026-10-23T23:12:09+02:00'.
- `subtitle` (text): Its subtitle, when it has one.
- `title` (text): Its title, in the document's own language.
- `url` (text): Its page on HAL, always showing the newest version.
- `version` (number): Its version number on HAL, from 1.
- `volume` (text): The journal volume.

**Example output**

```json
{
  "abstract": "Notwithstanding its size and importance in a globalized world, there is little systematic information about the volume and direction of human travel that considers both migration and other kinds of mobility. This...",
  "anr_projects": [],
  "arxiv_id": null,
  "author_names": [
    "Tobias Grohmann",
    "Ettore Recchi"
  ],
  "author_orcids": [
    "0000-0002-3051-1165",
    "0000-0001-7497-2150"
  ],
  "authors": [
    {
      "affiliations": [
        "European University Institute - Institut Universitaire Europ\u00e9en"
      ],
      "author_id": "3600618-1555182",
      "idhal": null,
      "name": "Tobias Grohmann"
    },
    {
      "affiliations": [
        "Centre de recherche sur les in\u00e9galit\u00e9s sociales (Sciences Po, CNRS)"
      ],
      "author_id": "849755-993811",
      "idhal": "ettore-recchi",
      "name": "Ettore Recchi"
    }
  ],
  "book_title": null,
  "citation": "Tobias Grohmann, Ettore Recchi, Luca Bernasconi. The 10 billion travel world: Continuity and change in global transnational mobility (1995\u20132022). Data & Policy, 2026, 8, \u27e810.1017/dap.2026.10102\u27e9. \u27e8hal-05837653\u27e9",
  "collections": [
    {
      "code": "SHS",
      "name": "Sciences de l'Homme et de la Soci\u00e9t\u00e9"
    },
    {
      "code": "SCIENCESPO",
      "name": "Sciences Po"
    }
  ],
  "conference": null,
  "doc_subtype": "DATAPAPER",
  "doc_type": "ART",
  "doc_type_label": "Journal articles",
  "doi": "10.1017/dap.2026.10102",
  "doi_url": "https://doi.org/10.1017/dap.2026.10102",
  "domains": [
    {
      "code": "shs.socio",
      "label": "Humanities and Social Sciences/Sociology"
    }
  ],
  "european_projects": [],
  "files": [
    "https://sciencespo.hal.science/hal-05837653/file/the-10-billion-travel-world-continuity-and-change-in-global-transnational-mobility-1995-2022.pdf"
  ],
  "full_text_on_hal": true,
  "hal_id": "hal-05837653",
  "issue": null,
  "journal": "Data & Policy",
  "journal_id": 171628,
  "journal_issn": "2632-3249",
  "keywords": [
    "Human mobility",
    "Migration",
    "Tourism",
    "Transnationalism"
  ],
  "language": "en",
  "licence": "https://creativecommons.org/licenses/by/4.0/",
  "modified_at": "2026-10-24T03:04:07+02:00",
  "open_access": true,
  "open_access_url": "https://sciencespo.hal.science/hal-05837653/document",
  "pages": null,
  "pdf_url": "https://sciencespo.hal.science/hal-05837653/document",
  "portal": "sciencespo",
  "produced_date": "2026",
  "publication_date": "2026",
  "publisher": "University of Cambridge Press",
  "pubmed_id": null,
  "released_at": "2026-10-23T19:36:06+02:00",
  "structures": [
    {
      "id": 1140212,
      "name": "Centre de recherche sur les in\u00e9galit\u00e9s sociales (Sciences Po, CNRS)",
      "type": "laboratory"
    },
    {
      "id": 169834,
      "name": "European University Institute - Institut Universitaire Europ\u00e9en",
      "type": "institution"
    },
    {
      "id": 301587,
      "name": "Sciences Po",
      "type": "institution"
    }
  ],
  "submitted_at": "2026-10-23T19:34:53+02:00",
  "subtitle": null,
  "title": "The 10 billion travel world: Continuity and change in global transnational mobility (1995\u20132022)",
  "url": "https://sciencespo.hal.science/hal-05837653",
  "version": 1,
  "volume": "8"
}
```

### Get a structure

Get one lab, team or institution in HAL by its structure ID, ROR ID or RNSR number: its name, kind, address, website, codes, identifiers, the structures it belongs to, how many belong to it, and how many documents it has.

**Inputs**

- Structure (`structure`, text, required): The structure ID from 'Search structures', a ROR ID or link, an RNSR number, or its AureHAL link.

**Outputs**

- `acronym` (text): Its acronym, such as 'LORIA'.
- `address` (text): Its postal address.
- `codes` (list): Its official codes, such as a CNRS unit number 'UMR7503'.
- `country` (text): Its country's two-letter code, such as 'FR'.
- `country_name` (text): Its country, such as 'France'.
- `document_count` (number): How many documents in HAL are linked to it.
- `end_date` (text): When it closed, for a closed structure.
- `hal_url` (text): Its page in AureHAL, HAL's register of structures.
- `id` (number): HAL's ID for the structure, such as 206040: 'Structures' in 'Search documents', 'Get a structure' and 'List sub-structures' take it.
- `idref` (text): Its IdRef number.
- `isni` (text): Its ISNI.
- `name` (text): Its name.
- `parents` (list): The structures it belongs to (a lab's university and CNRS, a team's lab).
- `rnsr` (text): Its RNSR number (France's register of research structures).
- `ror` (text): Its ROR ID as a link, such as https://ror.org/00f7srh09.
- `start_date` (text): When it was set up, as HAL records it.
- `status` (text): How HAL's librarians rate the record: 'valid' (checked), 'old' (closed or replaced by another) or 'incoming' (added by a depositor, not yet checked).
- `sub_structure_count` (number): How many structures belong to it ('List sub-structures' lists them).
- `type` (text): Its kind: researchteam, department, laboratory, regrouplaboratory, institution or regroupinstitution.
- `type_label` (text): Its kind in words, such as 'Laboratory'.
- `website` (text): Its website.
- `wikidata` (text): Its Wikidata link.

**Example output**

```json
{
  "acronym": "LORIA",
  "address": "Campus Scientifique BP 239 54506 Vandoeuvre-l\u00e8s-Nancy Cedex",
  "codes": [
    "UMR7503"
  ],
  "country": "FR",
  "country_name": "France",
  "document_count": 9953,
  "end_date": null,
  "hal_url": "https://aurehal.archives-ouvertes.fr/structure/read/id/206040",
  "id": 206040,
  "idref": "067077927",
  "isni": "0000000121795429",
  "name": "Laboratoire Lorrain de Recherche en Informatique et ses Applications",
  "parents": [
    {
      "acronym": null,
      "country": "FR",
      "id": 300009,
      "name": "Institut National de Recherche en Informatique et en Automatique",
      "status": "valid",
      "type": "institution"
    },
    {
      "acronym": null,
      "country": "FR",
      "id": 411575,
      "name": "CentraleSup\u00e9lec",
      "status": "valid",
      "type": "institution"
    },
    {
      "acronym": null,
      "country": "FR",
      "id": 413289,
      "name": "Universit\u00e9 de Lorraine",
      "status": "valid",
      "type": "institution"
    },
    {
      "acronym": null,
      "country": "FR",
      "id": 441569,
      "name": "Centre National de la Recherche Scientifique",
      "status": "valid",
      "type": "regroupinstitution"
    }
  ],
  "rnsr": "198912571S",
  "ror": "https://ror.org/02vnf0c38",
  "start_date": "2012-01-01",
  "status": "valid",
  "sub_structure_count": 9,
  "type": "laboratory",
  "type_label": "Laboratory",
  "website": "http://www.loria.fr",
  "wikidata": null
}
```

### Get an author

Get one author in HAL by idHAL, ORCID or author ID: their identifiers (ORCID, IdRef, ISNI, VIAF), current affiliations, HAL CV link and how many documents they authored.

**Inputs**

- Author (`author`, text, required): The author's idHAL, ORCID or author ID from 'Search authors'.

**Outputs**

- `affiliations` (list): The structures the author lists as their current affiliations.
- `arxiv` (text): Their arXiv author page.
- `author_id` (text): HAL's ID for this name form, such as '3061-307' (form, then person): 'Authors' in 'Search documents' and 'Get an author' take it.
- `document_count` (number): How many documents in HAL they authored.
- `email_domains` (list): The domains of the email addresses they deposit with, such as 'inria.fr' (the addresses themselves are private).
- `first_name` (text): Their first name.
- `idhal` (text): The author's idHAL, the name they claimed on HAL, such as 'laurentromary'. Empty for most authors.
- `idref` (text): Their IdRef link (the French academic authority file).
- `isni` (text): Their ISNI link.
- `last_name` (text): Their last name.
- `name` (text): Their full name.
- `orcid` (text): Their ORCID iD, such as '0000-0002-0756-0508'.
- `person_id` (number): HAL's ID for the person behind every form of their name, when known.
- `profile_url` (text): Their public HAL CV page, when they have one.
- `researcherid` (text): Their Web of Science ResearcherID link.
- `status` (text): 'preferred' (the person's main record), 'old' (another way their name was written) or 'incoming' (a name as a depositor typed it, not yet linked to a person).
- `viaf` (text): Their VIAF link.

**Example output**

```json
{
  "affiliations": [
    {
      "acronym": "ALMAnaCH",
      "country": "FR",
      "id": 482775,
      "name": "Automatic Language Modelling and ANAlysis & Computational Humanities",
      "status": "valid",
      "type": "researchteam"
    },
    {
      "acronym": "DCIS",
      "country": "FR",
      "id": 1159207,
      "name": "Direction de la Culture et de l\u2019Information Scientifiques",
      "status": "valid",
      "type": "department"
    }
  ],
  "arxiv": "https://arxiv.org/a/romary_l_1",
  "author_id": "3061-307",
  "document_count": 480,
  "email_domains": [
    "inria.fr",
    "loria.fr"
  ],
  "first_name": "Laurent",
  "idhal": "laurentromary",
  "idref": "https://www.idref.fr/060702494",
  "isni": "http://isni.org/isni/0000000388795444",
  "last_name": "Romary",
  "name": "Laurent Romary",
  "orcid": "0000-0002-0756-0508",
  "person_id": 307,
  "profile_url": "https://cv.hal.science/laurentromary",
  "researcherid": "http://www.researcherid.com/rid/A-5114-2012",
  "status": "preferred",
  "viaf": "https://viaf.org/viaf/282014122"
}
```

### List sub-structures

List the structures that belong to one in HAL, such as a university's labs or a lab's teams, A to Z, each with its structure ID, kind and how many documents it has.

**Inputs**

- Structure (`structure`, text, required): The parent structure: its ID from 'Search structures', a ROR ID or an RNSR number.
- Kinds (`types`, list): Only sub-structures of any of these kinds. Leave empty for every kind. One or more of: `researchteam` (Research team), `department`, `laboratory`, `regrouplaboratory` (Group of laboratories), `institution`, `regroupinstitution` (Group of institutions).
- Status (`status`, text): Only sub-structures HAL's librarians have checked (valid), closed or replaced ones (old), or ones a depositor added that nobody has checked yet (incoming). One of: `valid` (Valid (checked by HAL)), `old` (Closed or replaced), `incoming` (Not yet checked), `any` (Any status). Default: `valid`.
- How many to return (`limit`, number): How many structures to return on a page, up to 100. From 1 to 100. Default: `50`.
- Page (`page`, number): Which page of results to return, from 1. HAL pages through the first 10,000 matches. From 1 to 10000. Default: `1`.

**Outputs**

- `count` (number): How many are on this page.
- `has_more` (true/false): Whether another page has more.
- `parent` (object): The structure whose sub-structures these are.
- `structures` (list): The structures that belong to it, A to Z.
- `total` (number): How many match in all, across every page.

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "parent": {
    "acronym": "LORIA",
    "country": "FR",
    "id": 206040,
    "name": "Laboratoire Lorrain de Recherche en Informatique et ses Applications",
    "status": "valid",
    "type": "laboratory"
  },
  "structures": [
    {
      "acronym": "LORIA - ALGO",
      "address": null,
      "codes": [],
      "country": "FR",
      "country_name": "France",
      "document_count": 1321,
      "end_date": null,
      "hal_url": "https://aurehal.archives-ouvertes.fr/structure/read/id/423083",
      "id": 423083,
      "idref": null,
      "isni": null,
      "name": "Department of Algorithms, Computation, Image and Geometry",
      "parents": [
        {
          "acronym": "LORIA",
          "country": "FR",
          "id": 206040,
          "name": "Laboratoire Lorrain de Recherche en Informatique et ses Applications",
          "status": "valid",
          "type": "laboratory"
        }
      ],
      "rnsr": null,
      "ror": null,
      "start_date": null,
      "status": "valid",
      "type": "department",
      "type_label": "Department",
      "website": "http://www.loria.fr/en/research/departments/algorithms-computation-image-and-geometry/",
      "wikidata": null
    }
  ],
  "total": 8
}
```

### Search ANR projects

Find projects funded by the French National Research Agency (ANR) by acronym, title words or reference, each with the reference 'Search documents' takes, its programme, year and how many documents on HAL acknowledge it.

**Inputs**

- Search text (`query`, text, required): The project's acronym, words of its title, or its ANR reference.
- Status (`status`, text): Only projects HAL's librarians have checked (valid), closed or replaced ones (old), or ones a depositor added that nobody has checked yet (incoming). One of: `any` (Any status), `valid` (Valid (checked by HAL)), `incoming` (Not yet checked), `old` (Closed or replaced). Default: `any`.
- How many to return (`limit`, number): How many projects to return on a page, up to 100. From 1 to 100. Default: `20`.
- Page (`page`, number): Which page of results to return, from 1. HAL pages through the first 10,000 matches. From 1 to 10000. Default: `1`.

**Outputs**

- `count` (number): How many are on this page.
- `has_more` (true/false): Whether another page has more.
- `projects` (list): The ANR projects found, best match first.
- `total` (number): How many match in all, across every page.

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "projects": [
    {
      "acronym": "PostGenAI@Paris",
      "call": null,
      "document_count": 49,
      "id": 185716,
      "program": "IACL",
      "reference": "ANR-23-IACL-0007",
      "status": "valid",
      "title": "Post-generative artificial intelligence at Paris",
      "year": 2023
    }
  ],
  "total": 1
}
```

### Search authors

Find authors in HAL by name, idHAL or ORCID, each with the author ID 'Search documents' takes, their idHAL, ORCID and other identifiers, the domains of their email addresses and how many documents they authored.

**Inputs**

- Name (`query`, text, required): The author's name, or part of it; an idHAL or ORCID works too.
- Which authors (`include`, text): Identified authors have one record a person, linked to every form of their name. Many authors are only a name as a depositor typed it: choose every name form to find them too. One of: `identified` (Identified authors (one record a person)), `idhal` (Only authors with an idHAL), `any` (Every name form, checked or not). Default: `identified`.
- How many to return (`limit`, number): How many authors to return on a page, up to 100. From 1 to 100. Default: `20`.
- Page (`page`, number): Which page of results to return, from 1. HAL pages through the first 10,000 matches. From 1 to 10000. Default: `1`.

**Outputs**

- `authors` (list): The authors found, best match first.
- `count` (number): How many are on this page.
- `has_more` (true/false): Whether another page has more.
- `total` (number): How many match in all, across every page.

**Example output**

```json
{
  "authors": [
    {
      "arxiv": "https://arxiv.org/a/romary_l_1",
      "author_id": "3061-307",
      "document_count": 480,
      "email_domains": [
        "inria.fr",
        "loria.fr"
      ],
      "first_name": "Laurent",
      "idhal": "laurentromary",
      "idref": "https://www.idref.fr/060702494",
      "isni": "http://isni.org/isni/0000000388795444",
      "last_name": "Romary",
      "name": "Laurent Romary",
      "orcid": "0000-0002-0756-0508",
      "person_id": 307,
      "profile_url": "https://cv.hal.science/laurentromary",
      "researcherid": "http://www.researcherid.com/rid/A-5114-2012",
      "status": "preferred",
      "viaf": "https://viaf.org/viaf/282014122"
    }
  ],
  "count": 1,
  "has_more": false,
  "total": 1
}
```

### Search documents

Find articles, conference papers, preprints, theses, reports and other work deposited on HAL by words and by author, lab or institution, collection, portal, type, domain, language, journal, funding project, the dates deposited and produced, and whether it is free to read. Each comes with its title, authors and their affiliations, abstract, DOI, HAL ID, link, PDF link when HAL holds the full text, and dates.

**Inputs**

- Search text (`query`, text): Words to look for, all of them by default. Put a phrase in double quotes to match it exactly; OR between words matches either. Leave empty to filter with the other fields alone.
- Search in (`search_in`, text): Where the search text must appear. Everywhere covers titles, abstracts, keywords, authors, journals and more; the full text searches inside the files deposited on HAL. One of: `text` (Everywhere (titles, abstracts, keywords, authors and more)), `title` (Titles), `abstract` (Abstracts), `keywords`, `fulltext` (Full text of the deposited files). Default: `text`.
- Authors (`authors`, text): Only documents by any of these authors: an idHAL, an ORCID, or an author ID from 'Search authors', one per line or separated by commas.
- Author name (`author_name`, text): Only documents with an author of this name as written on them, in either order. 'Authors' is more precise when the author has an idHAL or an ORCID.
- Structures (`structures`, text): Only documents from any of these labs, teams or institutions (an institution includes its labs): a structure ID from 'Search structures', a ROR ID or an RNSR number, one per line or separated by commas.
- Collection (`collection`, text): Only documents in this HAL collection (a lab's, a project's or a conference's publication list), by its code: the part after hal.science/ in the collection's address.
- Portal (`portal`, text): Only what one HAL portal shows, such as TEL (every thesis) or a university's or institute's own archive. Leave empty for all of HAL.
- Document types (`doc_types`, list): Only documents of any of these types, such as journal articles, theses or preprints. Leave empty for every type.
- Scientific domains (`domains`, list): Only documents in any of these domains. A domain includes its subdomains. Leave empty for every domain.
- Languages (`languages`, list): Only documents written in any of these languages. Leave empty for every language.
- Journal (`journal`, text): Only articles in this journal: its ID from 'Search journals', or its ISSN.
- Funding project (`project`, text): Only documents that acknowledge this project: an ANR reference or a European grant number, as 'Search ANR projects' and 'Search European projects' give them.
- Deposited on or after (`submitted_after`, date): Only documents deposited on HAL on this day or later, in French time.
- Deposited on or before (`submitted_before`, date): Only documents deposited on HAL on this day or earlier.
- Produced on or after (`produced_after`, date): Only documents written or published on this day or later. One dated only by its year counts as 1 January.
- Produced on or before (`produced_before`, date): Only documents written or published on this day or earlier.
- Availability (`availability`, text): Only documents anyone can read for free (on HAL, or elsewhere such as arXiv or the publisher), or only those whose full text is on HAL. One of: `any` (Any document), `open_access` (Free to read, on HAL or elsewhere), `full_text` (With its full text on HAL). Default: `any`.
- Peer reviewed only (`peer_reviewed`, true/false): Only documents reviewed by a committee before publication. Default: `false`.
- Sort by (`sort`, text): The order of the results. Best match by default, which is the newest deposits first when there is no search text. One of: `relevance` (Best match (newest deposits first without search text)), `newest_deposit` (Newest deposits first), `oldest_deposit` (Oldest deposits first), `newest` (Most recently produced first), `oldest` (Earliest produced first), `recently_modified` (Most recently changed first). Default: `relevance`.
- How many to return (`limit`, number): How many documents to return on a page, up to 100. From 1 to 100. Default: `20`.
- Page (`page`, number): Which page of results to return, from 1. HAL pages through the first 10,000 matches. From 1 to 10000. Default: `1`.

**Outputs**

- `count` (number): How many are on this page.
- `documents` (list): The documents found.
- `has_more` (true/false): Whether another page has more.
- `page` (number): Which page this is, from 1.
- `total` (number): How many match in all, across every page.

**Example output**

```json
{
  "count": 1,
  "documents": [
    {
      "abstract": "Notwithstanding its size and importance in a globalized world, there is little systematic information about the volume and direction of human travel that considers both migration and other kinds of mobility. This...",
      "anr_projects": [],
      "arxiv_id": null,
      "author_names": [
        "Tobias Grohmann",
        "Ettore Recchi"
      ],
      "author_orcids": [
        "0000-0002-3051-1165",
        "0000-0001-7497-2150"
      ],
      "authors": [
        {
          "affiliations": [
            "European University Institute - Institut Universitaire Europ\u00e9en"
          ],
          "author_id": "3600618-1555182",
          "idhal": null,
          "name": "Tobias Grohmann"
        },
        {
          "affiliations": [
            "Centre de recherche sur les in\u00e9galit\u00e9s sociales (Sciences Po, CNRS)"
          ],
          "author_id": "849755-993811",
          "idhal": "ettore-recchi",
          "name": "Ettore Recchi"
        }
      ],
      "book_title": null,
      "citation": "Tobias Grohmann, Ettore Recchi, Luca Bernasconi. The 10 billion travel world: Continuity and change in global transnational mobility (1995\u20132022). Data & Policy, 2026, 8, \u27e810.1017/dap.2026.10102\u27e9. \u27e8hal-05837653\u27e9",
      "collections": [
        {
          "code": "SHS",
          "name": "Sciences de l'Homme et de la Soci\u00e9t\u00e9"
        },
        {
          "code": "SCIENCESPO",
          "name": "Sciences Po"
        }
      ],
      "conference": null,
      "doc_subtype": "DATAPAPER",
      "doc_type": "ART",
      "doc_type_label": "Journal articles",
      "doi": "10.1017/dap.2026.10102",
      "doi_url": "https://doi.org/10.1017/dap.2026.10102",
      "domains": [
        {
          "code": "shs.socio",
          "label": "Humanities and Social Sciences/Sociology"
        }
      ],
      "european_projects": [],
      "files": [
        "https://sciencespo.hal.science/hal-05837653/file/the-10-billion-travel-world-continuity-and-change-in-global-transnational-mobility-1995-2022.pdf"
      ],
      "full_text_on_hal": true,
      "hal_id": "hal-05837653",
      "issue": null,
      "journal": "Data & Policy",
      "journal_id": 171628,
      "journal_issn": "2632-3249",
      "keywords": [
        "Human mobility",
        "Migration",
        "Tourism",
        "Transnationalism"
      ],
      "language": "en",
      "licence": "https://creativecommons.org/licenses/by/4.0/",
      "modified_at": "2026-10-24T03:04:07+02:00",
      "open_access": true,
      "open_access_url": "https://sciencespo.hal.science/hal-05837653/document",
      "pages": null,
      "pdf_url": "https://sciencespo.hal.science/hal-05837653/document",
      "portal": "sciencespo",
      "produced_date": "2026",
      "publication_date": "2026",
      "publisher": "University of Cambridge Press",
      "pubmed_id": null,
      "released_at": "2026-10-23T19:36:06+02:00",
      "structures": [
        {
          "id": 1140212,
          "name": "Centre de recherche sur les in\u00e9galit\u00e9s sociales (Sciences Po, CNRS)",
          "type": "laboratory"
        },
        {
          "id": 169834,
          "name": "European University Institute - Institut Universitaire Europ\u00e9en",
          "type": "institution"
        },
        {
          "id": 301587,
          "name": "Sciences Po",
          "type": "institution"
        }
      ],
      "submitted_at": "2026-10-23T19:34:53+02:00",
      "subtitle": null,
      "title": "The 10 billion travel world: Continuity and change in global transnational mobility (1995\u20132022)",
      "url": "https://sciencespo.hal.science/hal-05837653",
      "version": 1,
      "volume": "8"
    }
  ],
  "has_more": true,
  "page": 1,
  "total": 38
}
```

### Search European projects

Find projects funded by the European Union (Horizon Europe, H2020, ERC and earlier programmes) by acronym, title words or grant number, each with the grant number 'Search documents' takes, its programme, dates and how many documents on HAL acknowledge it.

**Inputs**

- Search text (`query`, text, required): The project's acronym, words of its title, or its grant agreement number.
- Status (`status`, text): Only projects HAL's librarians have checked (valid), closed or replaced ones (old), or ones a depositor added that nobody has checked yet (incoming). One of: `any` (Any status), `valid` (Valid (checked by HAL)), `incoming` (Not yet checked), `old` (Closed or replaced). Default: `any`.
- How many to return (`limit`, number): How many projects to return on a page, up to 100. From 1 to 100. Default: `20`.
- Page (`page`, number): Which page of results to return, from 1. HAL pages through the first 10,000 matches. From 1 to 10000. Default: `1`.

**Outputs**

- `count` (number): How many are on this page.
- `has_more` (true/false): Whether another page has more.
- `projects` (list): The European projects found, best match first.
- `total` (number): How many match in all, across every page.

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "projects": [
    {
      "acronym": "PROMISE",
      "call": "ERC-2022-COG",
      "document_count": 14,
      "end_date": "2028-08-31",
      "funding": "ERC-2022-COG",
      "id": 732628,
      "openaire_id": "info:eu-repo/grantAgreement/101087830/EU/Proteome diversification in evolution/PROMISE",
      "reference": "101087830",
      "start_date": "2023-09-01",
      "status": "valid",
      "title": "Proteome diversification in evolution"
    }
  ],
  "total": 1
}
```

### Search journals

Find journals in HAL by words of their title or by ISSN, each with the journal ID 'Search documents' takes, its ISSNs, publisher, DOI prefix and how many of its articles HAL holds.

**Inputs**

- Title or ISSN (`query`, text, required): Words of the journal's title or abbreviated title, or its ISSN.
- Status (`status`, text): Only journals HAL's librarians have checked (valid), closed or replaced ones (old), or ones a depositor added that nobody has checked yet (incoming). One of: `any` (Any status), `valid` (Valid (checked by HAL)), `incoming` (Not yet checked), `old` (Closed or replaced). Default: `any`.
- How many to return (`limit`, number): How many journals to return on a page, up to 100. From 1 to 100. Default: `20`.
- Page (`page`, number): Which page of results to return, from 1. HAL pages through the first 10,000 matches. From 1 to 10000. Default: `1`.

**Outputs**

- `count` (number): How many are on this page.
- `has_more` (true/false): Whether another page has more.
- `journals` (list): The journals found, best match first.
- `total` (number): How many match in all, across every page.

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "journals": [
    {
      "abbreviated_title": "Nat Commun",
      "document_count": 6477,
      "doi_prefix": "10.1038/s41467",
      "eissn": "2041-1723",
      "id": 67823,
      "issn": "2041-1723",
      "publisher": "Nature Publishing Group",
      "status": "valid",
      "title": "Nature Communications",
      "website": "https://www.nature.com/ncomms/"
    }
  ],
  "total": 1
}
```

### Search structures

Find labs, research teams, departments and institutions in HAL by name, acronym or code (such as UMR7503), narrowed by kind, country and status. Each comes with the structure ID 'Search documents' takes, its parent structures, ROR ID, RNSR number and how many documents it has.

**Inputs**

- Search text (`query`, text): Words in the structure's name, its acronym or a code such as a CNRS unit number. Leave empty to browse with the other fields alone.
- Kinds (`types`, list): Only structures of any of these kinds. Leave empty for every kind. One or more of: `researchteam` (Research team), `department`, `laboratory`, `regrouplaboratory` (Group of laboratories), `institution`, `regroupinstitution` (Group of institutions).
- Country (`country`, text): Only structures in this country. Leave empty for every country. One of: `AF` (Afghanistan), `AL` (Albania), `DZ` (Algeria), `AS` (American Samoa), `AD` (Andorra), `AO` (Angola), `AI` (Anguilla), `AQ` (Antarctica), `AG` (Antigua & Barbuda), `AR` (Argentina), and 240 more.
- Status (`status`, text): Only structures HAL's librarians have checked (valid), closed or replaced ones (old), or ones a depositor added that nobody has checked yet (incoming). One of: `valid` (Valid (checked by HAL)), `old` (Closed or replaced), `incoming` (Not yet checked), `any` (Any status). Default: `valid`.
- How many to return (`limit`, number): How many structures to return on a page, up to 100. From 1 to 100. Default: `20`.
- Page (`page`, number): Which page of results to return, from 1. HAL pages through the first 10,000 matches. From 1 to 10000. Default: `1`.

**Outputs**

- `count` (number): How many are on this page.
- `has_more` (true/false): Whether another page has more.
- `structures` (list): The structures found, best match first.
- `total` (number): How many match in all, across every page.

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "structures": [
    {
      "acronym": "LORIA",
      "address": "Campus Scientifique BP 239 54506 Vandoeuvre-l\u00e8s-Nancy Cedex",
      "codes": [
        "UMR7503"
      ],
      "country": "FR",
      "country_name": "France",
      "document_count": 9953,
      "end_date": null,
      "hal_url": "https://aurehal.archives-ouvertes.fr/structure/read/id/206040",
      "id": 206040,
      "idref": "067077927",
      "isni": "0000000121795429",
      "name": "Laboratoire Lorrain de Recherche en Informatique et ses Applications",
      "parents": [
        {
          "acronym": null,
          "country": "FR",
          "id": 300009,
          "name": "Institut National de Recherche en Informatique et en Automatique",
          "status": "valid",
          "type": "institution"
        },
        {
          "acronym": null,
          "country": "FR",
          "id": 411575,
          "name": "CentraleSup\u00e9lec",
          "status": "valid",
          "type": "institution"
        },
        {
          "acronym": null,
          "country": "FR",
          "id": 413289,
          "name": "Universit\u00e9 de Lorraine",
          "status": "valid",
          "type": "institution"
        },
        {
          "acronym": null,
          "country": "FR",
          "id": 441569,
          "name": "Centre National de la Recherche Scientifique",
          "status": "valid",
          "type": "regroupinstitution"
        }
      ],
      "rnsr": "198912571S",
      "ror": "https://ror.org/02vnf0c38",
      "start_date": "2012-01-01",
      "status": "valid",
      "type": "laboratory",
      "type_label": "Laboratory",
      "website": "http://www.loria.fr",
      "wikidata": null
    }
  ],
  "total": 7
}
```
