Skip to content

Listar formularios de una entidad (marca blanca)

GET
/entities/{entityid}/config/forms

Returns forms for a specific entity (white label).

Parámetros:

  • ?type=legal|natural - Filtrar por tipo (opcional, si se omite retorna ambos mergeados)
  • ?name=base&type=legal|natural|legal,natural - Obtener SOLO el formulario básico (no todos los formularios configurados)

Diferencia importante:

  • Sin name=base: Retorna todos los formularios configurados mergeados (básico + personalizados)
  • Con name=base: Retorna SOLO el formulario básico (sin formularios personalizados)

Filtrado de campos:

  • Solo devuelve campos activos (actived=true)
  • Solo incluye campos de formularios del tipo especificado (legal o natural)
  • Filtra por categoría: legal (15-21) o natural (0-10)

NO requiere ownership - solo requiere ReadProfile permission.

Authorizations

bearerAuth

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

TypeHTTP (bearer)

Parameters

Header Parameters

Configuration-ID

UUID de la configuración de marca blanca. Se resuelve automáticamente por hostname o entidad única.

Typestring
formatuuid

Path Parameters

entityid*

ID de la entidad (white label)

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

Query Parameters

type

Tipo de formulario a filtrar (legal, natural, o legal,natural para ambos cuando name=base).

Comportamiento:

  • Solo devuelve campos activos (actived=true) de formularios del tipo especificado
  • Filtra campos por categoría: legal (15-21) o natural (0-10)
  • Solo incluye formularios que coinciden con el tipo solicitado
Typestring
Enum
legalnatural
Examplenatural
name

Si es "base", retorna SOLO el formulario básico (no todos los formularios configurados)

Typestring
Enum
base
Examplebase

Responses

Formularios de la entidad
application/json
JSON
{
"status": "success",
"data": {
"form": "string"
}
}

Playground

Server
Authorization
Headers
Variables
Key
Value

Samples

Powered by VitePress OpenAPI