Obtener una lista de los establecimientos

Lista todos los establecimientos registrados en el sistema. Incluye información de sucursales, tiendas y sedes administrativas.

---

Entorno

URL Base: https://api.guarani.app

Endpoint

GET /establecimientos?page=1&limit=100

Ejemplo de solicitud

curl -X GET "https://api.guarani.app/establecimientos?page=1&limit=100" \
  -H "x-api-key: Bearer <access_token>" \
  -H "Accept: application/json" | jq

Nota: Asegúrate de reemplazar <access_token> con un token JWT válido proporcionado por el equipo Guarani.
Importante:
Es imprescindible incluir un token de acceso válido en el encabezado x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.

---

Parámetros de ruta

Parámetro	Tipo	Requerido	Descripción
page	Integer	No	Número de la página a solicitar. Por defecto es 1.
limit	Integer	No	Cantidad de resultados por página. Si no se especifica, el valor por defecto es 10.

Encabezados de la Solicitud

Encabezado	Valor	Descripción
x-api-key	Bearer <access_token>	Token de autenticación necesario para acceder al recurso.
Accept	application/json	Indica que la respuesta debe devolverse en formato JSON.

Ejemplo de respuesta

{
  "success": true,
  "codigo": "200",
  "message": "Operación realizada correctamente.",
  "data": [
    {
      "id": "077abfe5-45a5-41c6-a82c-88ef8e8a2679",
      "numero_establecimiento": "001",
      "nombre": "Matriz",
      "direccion": "Avda. Principal esq. 1ra",
      "barrio": "Centro",
      "numero_casa": "101",
      "whatsapp": "+595981234567",
      "ciudad": {
        "id": "67ef2e9f-0fa7-43e7-ad5e-87a694e56341",
        "codigo_sifen": "3556",
        "nombre": "SANTA RITA"
      }
    }
  ],
  "pagination": {
    "total_registros": 1,
    "pagina": 1,
    "total_paginas": 1
  }
}

Descripción de Campos de Respuesta

Campos principales

Campo	Tipo	Descripción
id	uuid	Identificador único del establecimiento.
numero_establecimiento	string	Número que identifica al establecimiento.
nombre	string	Nombre del establecimiento.
direccion	string	Dirección física del establecimiento.
barrio	string	Nombre del barrio donde se encuentra el establecimiento.
numero_casa	string	Número de casa o edificio.
whatsapp	string	Número de WhatsApp del establecimiento en formato internacional.
ciudad	objeto	Información de la ciudad donde se ubica el establecimiento.

Campos de ciudad

Campo	Tipo	Descripción
id	uuid	Identificador único de la ciudad.
codigo_sifen	string	Código de la ciudad según el catálogo SIFEN.
nombre	string	Nombre de la ciudad.

Campos de paginación

Campo	Tipo	Descripción
total_registros	number	Cantidad total de establecimientos en el sistema.
pagina	number	Número de página actual.
total_paginas	number	Cantidad total de páginas disponibles.

Recursos adicionales

Para más información sobre posibles errores y cómo manejarlos, consulta errores