Consultar formulario en Typeform, con una API
Devuelve la definición completa de un formulario: configuración, tema, workspace, hidden fields, pantallas, lógica y los campos con sus ids y refs. Los ids de los campos son lo que filtran las tools de respuestas.
- Identificador
- typeform_get_form
La llamada
POST https://connect.reportei.com/api/tools/typeform_get_form/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"form_id": "<form_id>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| form_id | string | Sí | Id of the form, from List forms or from the form URL: u6nXL7 in https://mysite.typeform.com/to/u6nXL7. |
Conexiones posibles
Tu cliente conecta su cuenta de Typeform una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/typeform, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/typeform_get_form. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Typeform
- Listar workspacesGETLista los workspaces a los que accede la cuenta, entre sus organizaciones, con id, name, self.href y el número de formularios. Pagina con page hasta llegar al page_count de la respuesta.
- Crear workspacePOSTCrea un workspace en la organización en la que el usuario conectado es propietario y lo devuelve con id y self.href.
- Listar formulariosGETLista los formularios de la cuenta, públicos y privados, con id, título, fechas y el enlace público en _links.display. Pagina con page hasta llegar al page_count de la respuesta.
- Crear formularioPOSTCrea un formulario en un workspace y lo devuelve con id, ids de los campos y el enlace público en _links.display. Las imágenes en campos y pantallas ya deben existir en la cuenta.
- Actualizar formularioPUTReemplaza la definición completa de un formulario. Léelo con Get form, cambia lo que necesites y envía todo de vuelta: cada campo conserva su id, y un campo omitido se elimina junto con sus respuestas en las respuestas existentes.
- Listar respuestasGETLista las respuestas de un formulario, de la más nueva a la más antigua, con answers, hidden fields, variables, metadatos y las horas landed_at y submitted_at. Las respuestas de los últimos 30 minutos pueden faltar. El cuerpo trae total_items; para la página siguiente, envía el response_id del último elemento como before.
- Buscar respuestasPOSTBusca las respuestas de un formulario por valores de respuesta, tags, hidden fields, metadatos u hora de envío, todas las condiciones juntas. Úsala en lugar de List responses para filtrar por una respuesta. Para la página siguiente, envía el response_id del último elemento como before_response_id.
- Listar temasGETLista los temas de la cuenta, del más nuevo al más antiguo, con id, nombre, colores y fuente. Pagina con page hasta llegar al page_count de la respuesta.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
