Kuenta Docs

Appearance

Listar perfiles de usuario​

GET
/profiles

Obtiene la lista de todos los perfiles asociados al usuario autenticado.

Uso

Este endpoint permite obtener todos los perfiles (naturales y jurídicos) que el usuario tiene permiso para visualizar, incluyendo tanto perfiles propios como compartidos.

Permisos requeridos

  • ReadProfile: Lectura de perfiles

Authorizations​

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters​

Header Parameters

Config-Organization-ID*

ID único de la organización para la cual se consultan los perfiles.

Formato: UUID v4
Validación: Debe corresponder a una organización activa

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid
Organization-ID*

ID de la organización (campo legacy, usar Config-Organization-ID preferentemente).

Nota: En futuras versiones este header será deprecado.

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid

Query Parameters

expand

Campos relacionados a expandir en la respuesta.

Opciones disponibles:

  • entity: Incluye información completa de la entidad
  • natural: Incluye datos de persona natural
  • legal: Incluye datos de persona jurídica
  • city: Incluye información de ciudades relacionadas
Typestring
Enum
entitynaturallegalcity
Exampleentity
type

Filtrar por tipo de perfil.

Opciones:

  • 1: Solo perfiles de personas naturales
  • 2: Solo perfiles de personas jurídicas
Typeinteger
Enum
12
Example1
status

Filtrar por estado del perfil.

Estados:

  • true: Solo perfiles activos
  • false: Solo perfiles inactivos
Typeboolean
Exampletrue
shared

Incluir perfiles compartidos.

Opciones:

  • true: Incluir perfiles compartidos con el usuario
  • false: Solo perfiles propios (por defecto)
Typeboolean
Exampletrue
defaultfalse

Responses​

Lista de perfiles obtenida exitosamente
application/json
JSON
{
"message": "profiles",
"data": [
{
"ID": "123e4567-e89b-12d3-a456-426614174000",
"type": "natural",
"entityID": "456e7890-e89b-12d3-a456-426614174001",
"isCopy": false,
"createdAt": "2023-12-01T10:30:00Z",
"updatedAt": "2023-12-01T15:45:30Z"
},
{
"ID": "234e5678-e89b-12d3-a456-426614174001",
"type": "legal",
"entityID": "567e8901-e89b-12d3-a456-426614174002",
"isCopy": false,
"createdAt": "2023-11-20T08:00:00Z",
"updatedAt": "2023-12-01T12:30:00Z"
}
],
"meta": {
"total": 2,
"natural_count": 1,
"legal_count": 1,
"shared_count": 0
}
}

Playground​

Server
Authorization
Headers
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI