> ## Documentation Index
> Fetch the complete documentation index at: https://help.impactu.colav.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Search persons

> Paginated search of persons (researchers) by keywords and filters.

## Query parameters

**keywords** `string`

Search text (name or part of the person's name).

**max** `integer` (default: 10)

Results per page (1 to 250).

**page** `integer` (default: 1)

Page number (minimum 1).

**sort** `string` (default: citations\_desc)

Ascending or descending sort criterion, for example `citations_desc`,
`products_asc` or `alphabetical_desc`.

**sort** `string` (default: citations\_desc)

Sort with the format `field_direction`, where the direction is `asc` or
`desc`. Fields for persons: `citations`, `products`, `h` and `h5`. Example:
`products_desc`.

**view** `string` (default: full)

Level of detail of the response. `full` returns every field. `summary`
returns only the entity's main fields and, for products, patents and
projects, cuts the author list to 10. Any other value returns `400`.

> [!NOTE]
>
> If you don't send `max`, `page` or `sort`, `max=10`, `page=1` and
> `sort=citations_desc` apply. If you send `max` and `page` without `sort`,
> `sort=citations_desc` applies.

## Response

**data** `array`

List of persons.

**properties of each person**

**id** `string`

Person identifier.

**full\_name** `string`

Full name.

**first\_names** `string[]`

First names.

**last\_names** `string[]`

Last names.

**initials** `string`

Initials.

**aliases** `string[]`

Name variants with which the author appears in the sources.

**sex** `string | null`

Sex.

**products\_count** `integer`

Number of products.

**h\_index** `integer`

H-index.

**h5\_index** `integer`

H-index of the last 5 years.

**citations\_count** `object[]`

Citations by source: `count`, `source`, `provenance`.

**external\_ids** `object[]`

External identifiers (`id`, `source`, `provenance`), such as ORCID,
OpenAlex, Scienti or Google Scholar.

**affiliations** `object[]`

Affiliations of the person (institution, faculty, department, group).
Dates (`start_date`, `end_date`) are in Unix seconds. An
`end_date` of `-1` means a current affiliation.

**degrees** `object[]`

Academic degrees.

**ranking** `object[]`

Categories and classifications (contract, working hours, job category,
Minciencias).

**subjects** `object[]`

Subject areas grouped by source.

**keywords** `string[]`

Keywords.

**related\_works** `array`

Related works.

**updated** `object[]`

Date of the last update by source (`source`, `time` in Unix
seconds).

**meta** `object`

Response metadata.

**properties**

**count** `integer`

Total number of results matching the query.

**page** `integer`

Current page.

**size** `integer`

Number of results returned on this page.

**db\_response\_time\_ms** `integer`

Database response time in milliseconds.

**cursor** `object`

**properties**

**next** `string | null`

URL of the next page.

**previous** `string | null`

URL of the previous page.

```json 200 theme={null}
{
  "data": [
    {
      "affiliations": [
        {
          "end_date": -1,
          "external_urls": [],
          "id": "example-institution-id",
          "name": "Universidad Ejemplo",
          "position": null,
          "start_date": 1514851200,
          "types": [{"code": null, "level": null, "provenance": null, "source": "ror", "type": "education", "type_class": null}],
          "years": [2018]
        }
      ],
      "aliases": ["maría ejemplo garcía"],
      "citations_count": [{"count": 18, "provenance": null, "source": "openalex"}],
      "degrees": [{"date": -1, "degree": "maestría", "id": "", "institutions": [], "source": "nivel_académico"}],
      "external_ids": [{"id": "0000000001", "provenance": "scienti", "source": "scienti"}],
      "first_names": ["María"],
      "full_name": "María Ejemplo García",
      "h5_index": 3,
      "h_index": 3,
      "id": "0000000001",
      "initials": "M",
      "keywords": [],
      "last_names": ["Ejemplo"],
      "products_count": 21,
      "ranking": [
        {
          "date": 1514869200,
          "from_date": null,
          "issn": null,
          "level": null,
          "order": null,
          "rank": "vinculado",
          "source": "tipo_contrato",
          "to_date": null
        }
      ],
      "related_works": [],
      "sex": "Hombre",
      "subjects": [],
      "updated": [{"source": "staff", "time": 1790089863}]
    },
    {
      "affiliations": [
        {
          "end_date": 1797552000,
          "external_urls": [],
          "id": "example-institution-id",
          "name": "Universidad Ejemplo",
          "position": null,
          "start_date": 1768780800,
          "types": [{"code": null, "level": null, "provenance": null, "source": "ror", "type": "education", "type_class": null}],
          "years": [2026]
        }
      ],
      "aliases": ["juan ejemplo pérez"],
      "citations_count": [{"count": 54, "provenance": null, "source": "openalex"}],
      "degrees": [],
      "external_ids": [{"id": "0000000002", "provenance": "scienti", "source": "scienti"}],
      "first_names": ["Juan"],
      "full_name": "Juan Ejemplo Pérez",
      "h5_index": 1,
      "h_index": 3,
      "id": "0000000002",
      "initials": "J",
      "keywords": [],
      "last_names": ["Ejemplo"],
      "products_count": 96,
      "ranking": [
        {
          "date": 1768798800,
          "from_date": null,
          "issn": null,
          "level": null,
          "order": null,
          "rank": "ocasional",
          "source": "tipo_contrato",
          "to_date": null
        }
      ],
      "related_works": [],
      "sex": "Hombre",
      "subjects": [
        {
          "provenance": "minciencias",
          "source": "OECD",
          "subjects": [
            {
              "external_ids": [{"id": "2", "provenance": null, "source": "OECD"}],
              "id": "",
              "level": 0,
              "name": "Ingeniería y Tecnología"
            }
          ]
        }
      ],
      "updated": [{"source": "staff", "time": 1790089863}]
    }
  ],
  "meta": {
    "count": 1542618,
    "cursor": {"next": "https://api.dev.impactu.colav.co/search/person?max=2&page=2", "previous": null},
    "db_response_time_ms": 25,
    "page": 1,
    "size": 2
  }
}
```

```json 400 theme={null}
{
  "error": "1 validation error for QueryParams\nmax\n  Input should be greater than or equal to 1 [type=greater_than_equal, input_value='0', input_type=str]\n    For further i…"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.