Cómo consultar

La version 3 de la API REST de QuienEsQuien está disponible públicamente sin necesidad de registrarse y sin limitaciones vía HTTPS.

Filtros

Consultar cada endpoint (extremo, o punto de consulta de la API) sin parámetros hará que se devuelva el total de las entidades disponibles, utilizando los límites por defecto (25 entradas). Si quieres modificar la consulta, limitándola a aquellas entradas que coincidan con ciertos criterios, ordeńandolas o expandiendo las referencias de cada entrada, debes usar los filtros.

Hay algunos filtros genéricos que aplican a todos los endpoints, y otros que aplican a cada endpoint en particular. Listaremos aquí los genéricos.

limit

La cantidad de registros que se incluyen en cada página de resultados. Default: 25 registros. Tipo: 1000 >= entero > 0. La suma de limit y offset no puede ser superior a 10000.

offset

El número de registros a omitir desde el principio. Default: 0 registros (página inicial). Tipo: entero >= 0. Si el offset es mayor al número total de registros devuelve una respuesta vacía. La suma de limit y offset no puede ser superior a 10000.

embed

Bandera que indica si se incluyen referencias a otras colecciones dentro de cada documento en la respuesta. Esto inclurá las memberships, flags y summaries para cada entidad que lo tenga disponible. Default: false. Tipo: boolean.

format

Variable para indicar el formato de la respuesta. Por ahora el único formato alternativo disponible es “csv”. Si no se especifica se devuelve en json. Para cada tipo de entidad se generan diferentes tablas con los campos disponbles.

source

El identificador de una fuente, esto sirve para filtrar sólo las entidades que provengan de esta fuente. Para saber cuáles existen puede revisar el endpoint /sourcesList

db_prefix

Este parámetro está sólo para motivos de pruebas internas, no existe ningún valor que retorne resultados.