Kuenta Docs

Appearance

Listar organizaciones accesibles​

GET
/organizations

Obtiene la lista de todas las organizaciones accesibles para el usuario actual. Incluye información básica de cada organización, permisos y estado de activación.

Authorizations​

bearerAuth

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

TypeHTTP (bearer)

Parameters​

Query Parameters

page

Número de página para paginación

Typeinteger
Example1
minimum1
default1
limit

Número de registros por página

Typeinteger
Example20
minimum1
maximum100
default20
search

Texto para búsqueda por nombre o identificación

Typestring
ExampleFintech
minLength3
status

Estado de la organización

Typestring
Enum
activeinactivependingsuspended
Exampleactive
sortBy

Campo para ordenar los resultados

Typestring
Enum
namecreatedAtlastActivitymemberCount
Examplename
defaultname
sortOrder

Orden de clasificación

Typestring
Enum
ascdesc
Exampleasc
defaultasc

Responses​

Lista de organizaciones obtenida exitosamente
application/json
JSON
{
"success": true,
"message": "success",
"data": {
"organizations": [
{
"organizationId": "789f0123-4567-89ab-cdef-012345678901",
"name": "Fintech Innovadora S.A.S.",
"displayName": "Fintech Innovadora",
"organizationType": "string",
"identification": {
"type": "NIT",
"number": "900123456-7",
"country": "CO"
},
"contactInfo": {
"email": "[email protected]",
"phone": "+57 1 234 5678",
"website": "https://fintechinnovadora.com"
},
"address": {
"street": "Calle 100 #15-20",
"city": "Bogotá",
"state": "Bogotá D.C.",
"country": "Colombia",
"postalCode": "110111"
},
"status": "string",
"subscriptionInfo": {
"planName": "Plan Empresarial Premium",
"planType": "enterprise",
"status": "active",
"nextBillingDate": "2024-02-01"
},
"memberInfo": {
"totalMembers": 15,
"activeMembers": 12,
"adminMembers": 3
},
"userRole": {
"roleName": "Admin",
"permissions": [
[
"read_organization",
"write_organization",
"manage_members"
]
],
"canManage": true
},
"lastActivity": "2024-01-15T14:30:00Z",
"createdAt": "2023-01-15T10:00:00Z",
"updatedAt": "2024-01-15T16:45:00Z"
}
],
"pagination": {
"currentPage": 1,
"totalPages": 3,
"totalRecords": 45,
"hasNextPage": true,
"hasPreviousPage": false
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI