Upnify Documentación API
Inicia aquí · /integraciones/plantillas

Integraciones

Consultar plantillas de integración

GET/integraciones/plantillas

Lista las plantillas visibles para el usuario de la sesión, con su configuración y propietario. Permite filtrar por identificador y tipo de integración. Devuelve un arreglo, que puede estar vacío. Esta consulta no devuelve un total en el encabezado Row-Count. El filtro compartidas tiene un comportamiento particular: cualquier valor enviado limita el resultado a las plantillas propias; omítelo para no aplicar ese filtro. La visibilidad también depende de los permisos de compartición.

Parámetros

NombreTipoValidaciónDescripción
tkIntegracionPlantillavarcharConsulta: Identificador de una plantilla concreta. Hasta 64 caracteres.
compartidasintConsulta: Si se envía, limita el resultado a plantillas propias, incluso cuando vale 0.
tipoIntegracionintConsulta: Tipo de integración de las plantillas.
paginaintConsulta: Número de página, desde 1. Con 0 devuelve hasta 1000 registros.
cantidadRegistrosintConsulta: Cantidad de registros por página.
tokenStringRequeridoEncabezado: Token de sesión vigente obtenido al autenticarte. No lo registres ni lo expongas.

Respuesta

NombreTipoDescripción
indiceIntegerPosición del registro en el listado.
tkIntegracionPlantillaStringIdentificador de la plantilla.
nombreStringNombre de la plantilla.
configuracionObjectConfiguración guardada como JSON; puede ser null.
compartirIntegerValor de compartición guardado en la plantilla; puede ser null.
compartirTextoStringDescripción de compartición: Empresa, Nadie o Grupo.
tkGrupoStringIdentificador del grupo del propietario; puede ser null.
grupoStringNombre del grupo del propietario; puede ser null.
tkUsuarioStringIdentificador del propietario; puede ser null.
ejecutivoStringNombre del propietario.
inicialesStringIniciales del propietario; puede ser null.
ordenIntegerClasificación de pertenencia usada en la presentación.
esPropiaInteger1 si pertenece al usuario de la sesión; 0 en otro caso.

Solicitud

Consultar una página de plantillas

curl --request GET \
  --url 'https://api.upnify.com/integraciones/plantillas?pagina=1&cantidadRegistros=50' \
  --header 'Accept: application/json' \
  --header 'token: TOKEN-SESION-EJEMPLO'

Respuesta

Plantillas visibles (HTTP 200)

JSON
[
  {
    "indice": 1,
    "tkIntegracionPlantilla": "00000000-0000-4000-8000-000000000002",
    "nombre": "Captación web",
    "configuracion": {
      "nombre": "Formulario web"
    },
    "compartir": 0,
    "compartirTexto": "Nadie",
    "tkGrupo": "G-00000000-0000-4000-8000-000000000001",
    "grupo": "Grupo de ejemplo",
    "tkUsuario": "U-00000000-0000-4000-8000-000000000001",
    "ejecutivo": "Persona de ejemplo",
    "iniciales": "PE",
    "orden": 1,
    "esPropia": 1
  }
]