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

# Buscar afiliaciones

> Búsqueda paginada de afiliaciones (instituciones, facultades, departamentos y grupos).

## Parámetros de ruta

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

Tipo de afiliación a buscar: `institution`, `faculty`, `department` o `group`.

## Parámetros de consulta

**keywords** `string`

Texto de búsqueda (nombre de la afiliación).

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

Resultados por página (1 a 250).

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

Número de página (mínimo 1).

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

Criterio de ordenamiento ascendente y descendente, por ejemplo
`citations_desc`, `products_asc` o `alphabetical_desc`.

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

Ordenamiento con el formato `campo_direccion`, donde la dirección es `asc` o
`desc`. Campos para afiliaciones: `products` (mayor producción), `citations`
(más citaciones), `h` (índice h) y `h5` (índice h5). Ejemplo: `products_desc`.

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

Nivel de detalle de la respuesta. `full` devuelve todos los campos. `summary`
devuelve solo los campos principales de la entidad y, en productos, patentes y
proyectos, recorta la lista de autores a 10. Otro valor responde `400`.

### Filtros

Los tres filtros aceptan varios valores separados por coma.

**states** `string`

Departamentos de la dirección de la afiliación. Se usan los valores
normalizados y se incluyen sus variantes en la base de datos. Ejemplo:
`Antioquia,Tolima`.

**cities** `string`

Ciudades de la dirección de la afiliación. También se incluyen variantes como
"Bogotá, D.C." o "Santiago de Cali". Ejemplo: `Bogotá,Cali`.

**groups\_ranking** `string`

Clasificación vigente del grupo. Se compara con el ranking más reciente (por
`from_date`), sin importar su fuente. Ejemplo: `A1,A2`.

> [!NOTE]
>
> Si no envías `max`, `page` ni `sort`, se aplican `max=10`, `page=1` y
> `sort=citations_desc`. Si envías `max` y `page` sin `sort`, se aplica
> `sort=citations_desc`. Con `affiliation_type=institution` se incluyen todos
> los tipos de institución.

## Respuesta

**data** `array`

Lista de afiliaciones.

**propiedades de cada afiliación**

**id** `string`

Identificador de la afiliación.

**name** `string | null`

Nombre principal (en español si existe).

**names** `object[]`

Nombres por fuente (`name`, `lang`, `source`, `provenance`).

**abbreviations** `string[]`

Siglas.

**aliases** `string[]`

Nombres alternos.

**types** `object[]`

Tipos de la afiliación por fuente (`type`, `source`, `provenance`).

**addresses** `object[]`

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

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

Año de fundación.

**description** `object[]`

Descripciones por fuente.

**products\_count** `integer`

Cantidad de productos.

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

Citas por fuente (`count`, `source`, `provenance`).

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

Índice h.

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

Índice h de los últimos 5 años.

**ranking** `object[]`

Clasificaciones (por ejemplo, la de un grupo de investigación).

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

Afiliaciones superiores directas (por ejemplo, la institución de una
facultad). En la búsqueda puede llegar en `null`.

**relations** `object[]`

Afiliaciones relacionadas (`id`, `name`, `types`, `external_urls`). Por
ejemplo, la institución y los departamentos de una facultad.

**subjects** `object[]`

Áreas de conocimiento.

**status** `array`

Estado de la afiliación.

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

Identificadores externos (`id`, `source`, `provenance`).

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

Enlaces externos.

**updated** `object[]`

Última actualización por fuente (`source`, `time` en segundos Unix).

**meta** `object`

Metadatos de la respuesta.

**propiedades**

**count** `integer`

Total de resultados que cumplen la consulta.

**page** `integer`

Página actual.

**size** `integer`

Cantidad de resultados devueltos en esta página.

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

Tiempo de respuesta de la base de datos en milisegundos.

**cursor** `object`

**propiedades**

**next** `string | null`

URL de la página siguiente.

**previous** `string | null`

URL de la página anterior.

```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.