Obtener una lista de las empresas

Este endpoint permite consultar una lista de las empresas registradas en el sistema Guarani App, proporcionando los datos en un formato estructurado para facilitar el inicio y la gestión de las pruebas de la aplicación.

---

Entorno

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

Endpoint

GET /empresas

Ejemplo de solicitud

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

Nota: Reemplaza <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 página. Por defecto: 1.
limit	integer	No	Resultados por página. Por defecto: 10.

Encabezados de la Solicitud

Encabezado	Valor	Descripción
x-api-key	Bearer <access_token>	Token de acceso válido proporcionado por el equipo Guarani.
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": [
    {
      "empresa": {
        "id": "869943e3-7995-4eb6-9327-9868e0a93117",
        "nombre": "NOMBRE DE EJEMPLO",
        "nombre_fantasia": "NOMBRE DE EJEMPLO",
        "ruc": "12345678-9",
        "fecha_constitucion": "11/09/2025",
        "tipo_persona": 2
      },
      "representantes_legales": [
        {
          "id": "b8ab12ca-a33f-4edd-a345-c752c83c0849",
          "cedula": "12345678",
          "nombres": "NOMBRES DE EJEMPLO",
          "apellidos": "APELLIDOS DE EJEMPLO",
          "email": "[email protected]",
          "whatsapp": "+595981234567",
          "fecha_nacimiento": "11/09/2025"
        }
      ]
    }
  ],
  "pagination": {
    "total_registros": 1,
    "pagina": 1,
    "total_paginas": 1
  }
}

Descripción de Campos de Respuesta

Campos principales

Campo	Tipo	Descripción
empresa	objeto	Contiene la información completa de la empresa.
representantes_legales	array	Lista de representantes legales asociados a la empresa.

Campos de empresa

Campo	Tipo	Descripción
id	uuid	Identificador único de la empresa.
nombre	string	Nombre legal de la empresa.
nombre_fantasia	string	Nombre comercial o fantasía de la empresa.
ruc	string	Número de RUC de la empresa.
fecha_constitucion	string	Fecha de constitución de la empresa en formato DD/MM/YYYY.
tipo_persona	number	Tipo de persona. 2 = Persona Jurídica.

Campos de representantes_legales

Campo	Tipo	Descripción
id	uuid	Identificador único del representante legal.
cedula	string	Número de cédula del representante legal.
nombres	string	Nombres del representante legal.
apellidos	string	Apellidos del representante legal.
email	string	Correo electrónico del representante legal.
whatsapp	string	Número de WhatsApp del representante legal.
fecha_nacimiento	string	Fecha de nacimiento en formato DD/MM/YYYY.

Campos de paginación

Campo	Tipo	Descripción
total_registros	number	Cantidad total de empresas 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