Documentación

Paginación

La API de Aleluya usa paginación basada en offset para organizar grandes conjuntos de resultados. Los parámetros page, per_page, search y filter te permiten navegar y acotar los datos devueltos.

Estos parámetros no están disponibles en todos los endpoints. La referencia de cada endpoint indica cuáles los soportan.

Parámetros

Parámetro	Tipo	Default	Límites	Descripción
`page`	integer	`1`	1 – 9999	Número de página a obtener
`per_page`	integer	`20`	1 – 50	Registros por página
`search`	string	—	—	Filtra por texto en los campos del endpoint
`filter`	string	—	—	Filtro específico según el endpoint

Ejemplo de petición:

Code
curl --location 'https://nominapp-api-stage.herokuapp.com/v1/companies/{company_id}/workers?search=maria&filter=active&page=1&per_page=20' \
--header 'Authorization: Bearer TU_API_ACCESS_TOKEN' \
--header 'Accept: application/json'

Respuesta

Cuando los resultados se paginan, la respuesta incluye un objeto filters con el estado actual de la paginación:


Code
{
  "data": [ ],
  "filters": {
    "total_records": 150,
    "page": 2,
    "per_page": 10,
    "search": ""
  }
}

Campo	Tipo	Descripción
`total_records`	integer	Total de registros que coinciden con los filtros aplicados
`page`	integer	Página actual
`per_page`	integer	Registros por página solicitados
`search`	string	Término de búsqueda aplicado, o `""` si no hay búsqueda
`filter`	string	Filtro aplicado (solo en algunos endpoints)

Usa total_records y per_page para calcular el total de páginas disponibles: total_páginas = ceil(total_records / per_page).

Buenas prácticas

Verifica si data está vacío antes de procesar resultados, puede ocurrir en la última página, cuando los filtros no devuelven resultados, o al solicitar una página que no existe.
Usa valores razonables para per_page: aunque el máximo es 50, valores entre 10 y 20 reducen el tiempo de respuesta.
La búsqueda se aplica antes de la paginación: total_records refleja solo los registros que coinciden con search, no el total sin filtrar.

Last modified on April 27, 2026

Errores Diccionario de valores permitidos

Parámetros

Parámetro

Tipo

Default

Límites

Descripción

page

integer

1

1 – 9999

Número de página a obtener

per_page

integer

20

1 – 50

Registros por página

search

string

—

Filtra por texto en los campos del endpoint

filter

string

—

Filtro específico según el endpoint

Ejemplo de petición:

Code

curl --location 'https://nominapp-api-stage.herokuapp.com/v1/companies/{company_id}/workers?search=maria&filter=active&page=1&per_page=20' \
--header 'Authorization: Bearer TU_API_ACCESS_TOKEN' \
--header 'Accept: application/json'

Respuesta

Cuando los resultados se paginan, la respuesta incluye un objeto filters con el estado actual de la paginación:

Code

{
  "data": [ ],
  "filters": {
    "total_records": 150,
    "page": 2,
    "per_page": 10,
    "search": ""
  }
}

Campo

Tipo

Descripción

total_records

integer

Total de registros que coinciden con los filtros aplicados

page

integer

Página actual

per_page

integer

Registros por página solicitados

search

string

Término de búsqueda aplicado, o "" si no hay búsqueda

filter

string

Filtro aplicado (solo en algunos endpoints)

Usa total_records y per_page para calcular el total de páginas disponibles: total_páginas = ceil(total_records / per_page).

Buenas prácticas

Verifica si data está vacío antes de procesar resultados, puede ocurrir en la última página, cuando los filtros no devuelven resultados, o al solicitar una página que no existe.

Usa valores razonables para per_page: aunque el máximo es 50, valores entre 10 y 20 reducen el tiempo de respuesta.

La búsqueda se aplica antes de la paginación: total_records refleja solo los registros que coinciden con search, no el total sin filtrar.

Last modified on April 27, 2026