Saltar al contenido principal

Get public list of enabled countries

GET 

/company/country/

Devuelve una lista paginada de países habilitados en el sistema. Este endpoint proporciona los países disponibles para usar en formularios, filtros y selecciones geográficas.

Objetivo

Proporcionar a las aplicaciones frontend e integraciones externas una lista actualizada de países soportados por la plataforma para el registro de empresas, creación de direcciones y operaciones logísticas.

Casos de uso

  • Rellenar selectores de país en formularios de registro
  • Mostrar regiones de servicio disponibles a los usuarios
  • Filtrar subastas o entregas por área geográfica
  • Validar códigos de país proporcionados por los usuarios

Autenticación

Este es un endpoint PÚBLICO. No requiere autenticación.

Notas importantes

  • Solo devuelve países con enabled: true
  • Los países con deleted: true o enabled: false quedan excluidos
  • Los campos _id, deleted, enabled, createdAt, updatedAt, __v se filtran de la respuesta
  • Solo el campo code está garantizado en todos los registros
  • Los campos opcionales name e iso pueden estar presentes en algunos países
  • Paginación implementada con mongoose-paginate-v2
  • El tamaño de página por defecto proviene de process.env.ITEMS_PAGE (normalmente 25)

Ejemplo de solicitud:

# Obtener la primera página con el límite por defecto (25)
GET /company/country/

# Obtener la segunda página con 10 resultados
GET /company/country/?page=2&limit=10

# Obtener todos los países disponibles (si son menos de 50)
GET /company/country/?limit=50

Ejemplo de respuesta:

{
"status": 200,
"data": {
"docs": [
{"code": "es"},
{"code": "pt"},
{"code": "fr"},
{"code": "de", "name": "Germany", "iso": "DEU"}
],
"totalDocs": 22,
"limit": 25,
"page": 1,
"totalPages": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": false,
"prevPage": null,
"nextPage": null
}
}

Request

Responses

Operación exitosa. Devuelve la lista paginada de países habilitados.

La respuesta incluye los metadatos completos de paginación de mongoose-paginate-v2.

Response Headers