Listar empresas

GET /api/v1/companies

Este endpoint permite obtener un listado paginado de las empresas registradas en la plataforma.

Es útil para consultar la información de las empresas asociadas a su equipo. Permite realizar búsquedas por nombre, RUC, descripción o dirección para filtrar los resultados de manera eficiente.

La respuesta del endpoint incluye un conjunto de datos estructurados con la información relevante de cada empresa y los metadatos de paginación para facilitar la navegación entre los resultados.

ℹ Recuerda que:

La URL base para todas las solicitudes es: https://tu-dominio.c3.pe

Importante: reemplaza tu-dominio por el nombre de dominio específico que te haya proporcionado C3.

Solicitud

Cabeceras

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	✅ Sí	Token de autenticación (Bearer Token).

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
search	String	❌ No	Término de búsqueda para filtrar empresas por nombre, RUC, descripción o dirección.
page	Integer	❌ No	Número de la página que se desea obtener. Por defecto es 1.
per_page	Integer	❌ No	Cantidad de resultados por página. El valor por defecto es 15 y el rango es de 1 a 20

Ejemplo de solicitud

GET /api/v1/companies?search=20601543210

Respuesta

La API devuelve un objeto JSON con la siguiente estructura.

Respuesta base 200

{
	"message": "Datos obtenidos correctamente",
	"data": [
		{
			"id": 3,
			"name": "Soluciones Digitales Andinas S.A.C.",
			"ruc": "20601543210",
			"description": "Desarrollo de software",
			"address": "Av. Los Próceres 456, San Isidro, Lima, Perú",
			"created_at": "2025-04-22T17:19:42.000000Z"
		}
	],
	"pagination": {
		"total_items": 1,
		"items_per_page": 15,
		"current_page": 1,
		"total_pages": 1
	}
}

Definición de atributos

Campo	Tipo	Descripción
message	String	Mensaje de respuesta del servidor.
data	Array	Lista de empresas obtenidas.
data.id	Integer	Identificador único de la empresa.
data.name	String	Nombre o razón social de la empresa.
data.ruc	String	Número de RUC de la empresa.
data.description	String | null	Descripción o actividad principal de la empresa.
data.address	String | null	Dirección física de la empresa.
data.created_at	String	Fecha y hora de creación de la empresa.
pagination	Object	Información de la paginación.
pagination.total_items	Integer	Total de elementos encontrados.
pagination.items_per_page	Integer	Elementos por página.
pagination.current_page	Integer	Página actual.
pagination.total_pages	Integer	Total de páginas.

Errores generales

Código HTTP	Tipo	Causa común
401	Unauthorized	El token de acceso no fue proporcionado en el encabezado Authorization, es inválido o ha sido revocado. Verifique que el token sea correcto y esté activo.
422	Unprocessable Entity	La solicitud fue entendida, pero contiene errores semánticos que impiden su procesamiento. Esto puede deberse a: 1. Parámetros faltantes o inválidos (ej, from_date no es una fecha válida); 2. Recurso inexistente (wa_number no registrado en el sistema); 3. Violación de reglas de negocio (el rango de fechas excede el límite permitido).
500	Server Error	Error interno del servidor. Intenta nuevamente más tarde o contacta soporte técnico.