> ## 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 affiliations

> Paginated search of affiliations (institutions, faculties, departments and groups).

## Path parameters

**affiliation\_type** `string` *required*

Type of affiliation to search: `institution`, `faculty`, `department` or `group`.

## Query parameters

**keywords** `string`

Search text (affiliation 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 affiliations: `products` (most output), `citations`
(most citations), `h` (h-index) and `h5` (h5-index). 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`.

### Filters

The three filters accept several values separated by commas.

**states** `string`

Departments of the affiliation's address. The normalized values are used
and their variants in the database are included. Example:
`Antioquia,Tolima`.

**cities** `string`

Cities of the affiliation's address. Variants such as "Bogotá, D.C." or
"Santiago de Cali" are also included. Example: `Bogotá,Cali`.

**groups\_ranking** `string`

Current classification of the group. It is compared with the most recent ranking (by
`from_date`), whatever its source. Example: `A1,A2`.

> [!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`. With `affiliation_type=institution` all institution
> types are included.

## Response

**data** `array`

List of affiliations.

**properties of each affiliation**

**id** `string`

Affiliation identifier.

**name** `string | null`

Main name (in Spanish if there is one).

**names** `object[]`

Names by source (`name`, `lang`, `source`, `provenance`).

**abbreviations** `string[]`

Acronyms.

**aliases** `string[]`

Alternative names.

**types** `object[]`

Affiliation types by source (`type`, `source`, `provenance`).

**addresses** `object[]`

Addresses: `city`, `state`, `country`, `country_code`, `postcode`,
`lat`, `lng`.

**year\_established** `integer | null`

Year founded.

**description** `object[]`

Descriptions by source.

**products\_count** `integer`

Number of products.

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

Citations by source (`count`, `source`, `provenance`).

**h\_index** `integer | null`

H-index.

**h5\_index** `integer | null`

H-index of the last 5 years.

**ranking** `object[]`

Classifications (for example, a research group's).

**affiliations** `object[] | null`

Direct parent affiliations (for example, the institution of a
faculty). In the search it can come as `null`.

**relations** `object[]`

Related affiliations (`id`, `name`, `types`, `external_urls`). For
example, the institution and the departments of a faculty.

**subjects** `object[]`

Subject areas.

**status** `array`

Status of the affiliation.

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

External identifiers (`id`, `source`, `provenance`).

**external\_urls** `object[]`

External links.

**updated** `object[]`

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": [
    {
      "abbreviations": ["UE"],
      "addresses": [
        {
          "city": "Gothenburg",
          "country": "Suecia",
          "country_code": "SE",
          "lat": 57.70716,
          "lng": 11.96679,
          "postcode": "",
          "state": "Västra Götaland"
        }
      ],
      "affiliations": null,
      "aliases": [],
      "citations_count": [{"count": 69, "provenance": null, "source": "scholar"}],
      "description": [],
      "external_ids": [{"id": "example-grid-id", "provenance": "ror", "source": "grid"}],
      "external_urls": [{"provenance": null, "source": "grid", "url": "https://www.example.edu.co"}],
      "h5_index": 0,
      "h_index": 1,
      "id": "example-institution-id",
      "name": "Universidad Ejemplo",
      "names": [{"lang": "en", "name": "Universidad Ejemplo", "provenance": null, "source": "ror"}],
      "products_count": 1,
      "ranking": [],
      "relations": [],
      "status": ["active"],
      "subjects": [],
      "types": [{"code": null, "level": null, "provenance": null, "source": "ror", "type": "archive", "type_class": null}],
      "updated": [{"source": "ror", "time": 1789879262}],
      "year_established": 2001
    },
    {
      "abbreviations": ["UE"],
      "addresses": [
        {
          "city": "Londres",
          "country": "Reino Unido",
          "country_code": "GB",
          "lat": 51.50853,
          "lng": -0.12574,
          "postcode": "",
          "state": "England"
        }
      ],
      "affiliations": null,
      "aliases": [],
      "citations_count": [{"count": 83, "provenance": null, "source": "openalex"}],
      "description": [],
      "external_ids": [{"id": "example-wikidata-id", "provenance": "ror", "source": "wikidata"}],
      "external_urls": [{"provenance": "wikidata", "source": "logo", "url": "https://www.example.edu.co"}],
      "h5_index": 1,
      "h_index": 3,
      "id": "example-institution-id-2",
      "name": "Universidad Ejemplo 2",
      "names": [{"lang": "en", "name": "Universidad Ejemplo 2", "provenance": null, "source": "ror"}],
      "products_count": 11,
      "ranking": [],
      "relations": [],
      "status": ["active"],
      "subjects": [],
      "types": [{"code": null, "level": null, "provenance": null, "source": "ror", "type": "archive", "type_class": null}],
      "updated": [{"source": "ror", "time": 1789879262}],
      "year_established": 1753
    }
  ],
  "meta": {
    "count": 55111,
    "cursor": {"next": "https://api.dev.impactu.colav.co/search/affiliations/institution?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.