InicioDocumentaciónReferencia API

Referencia API

Referencia y listado técnico constante de los endpoints.

Resumen

La API InboundFlow utiliza convenciones REST. Todas las respuestas son JSON. Las marcas de tiempo están en ISO 8601 UTC.

📞Llamadas

Listar todas las llamadas

GET/v1/calls

Parámetros de Consulta

ParámetroTipoDefectoDescripción
limitinteger50Resultados por página (defecto: 50, máx: 100)
cursorstringnullCursor de paginación de la respuesta anterior
sincestringnullFecha ISO — llamadas posteriores a este momento
statusstringnullFiltro por estado: completed, failed, blocked, in-progress, forwarding
phonestringnullFiltrar por número telefónico
cURL
curl -X GET "https://api.inboundflow.app/v1/calls?limit=10&status=completed" \
  -H "Authorization: Bearer sk_live_your_key_here"

Respuesta

JSON
{
  "data": [
    {
      "id": "uuid",
      "caller_phone": "+1234567890",
      "caller_name": "Dave",
      "status": "completed",
      "duration_seconds": 55,
      "summary": "Called about auto repair...",
      "transcript": "Full conversation transcript...",
      "recording_url": "https://...",
      "transfer_status": null,
      "started_at": "2026-02-24T20:59:00Z",
      "ended_at": "2026-02-24T21:00:00Z",
      "assistant_id": "uuid",
      "contact_id": "uuid",
      "created_at": "2026-02-24T20:59:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-24T21:05:00Z"
  }
}

Obtener una llamada

GET/v1/calls/:call_id
cURL
curl -X GET "https://api.inboundflow.app/v1/calls/07f51470-ef1d-421c-a847-36e98732bb9b" \
  -H "Authorization: Bearer sk_live_your_key_here"

Respuesta: Objeto de llamada único. Incluye el arreglo completo messages (historial de conversación), ausente en el endpoint de lista.

👤Contactos

Listar todos los contactos

GET/v1/contacts

Parámetros de Consulta

ParámetroTipoDefectoDescripción
limitinteger50Resultados por página (defecto: 50, máx: 100)
cursorstringnullCursor de paginación
sincestringnullFiltro de fecha ISO
phonestringnullFiltrar por número exacto
cURL
curl -X GET "https://api.inboundflow.app/v1/contacts?limit=10" \
  -H "Authorization: Bearer sk_live_your_key_here"

Respuesta

JSON
{
  "data": [
    {
      "id": "dbf31702-3468-4639-a5a4-e07f9bdae9a7",
      "phone": "+14155551234",
      "name": "Maria Garcia",
      "email": "maria.garcia@gmail.com",
      "company": null,
      "source": "inbound_call",
      "total_calls": 5,
      "last_call_at": "2026-02-23T15:00:00Z",
      "notes": "Regular customer, Toyota Camry 2019",
      "created_at": "2026-02-20T14:00:00Z",
      "updated_at": "2026-02-23T15:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "meta": {
    "request_id": "req_abc123def456",
    "timestamp": "2026-02-24T00:00:00Z"
  }
}

Obtener un contacto

GET/v1/contacts/:contact_id

Respuesta: Objeto contacto único (misma estructura que la lista).

Crear un contacto

POST/v1/contacts
cURL
curl -X POST \
  "https://api.inboundflow.app/v1/contacts" \
  -H "Authorization: Bearer sk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+14155559999",
    "name": "Juan López",
    "email": "juan@ejemplo.com",
    "company": "Example Co",
    "notes": "New contact"
  }'

🎯Prospectos

Listar todos los prospectos

GET/v1/leads

Parámetros de Consulta

ParámetroTipoDefectoDescripción
limitinteger50Resultados por página (defecto: 50, máx: 100)
cursorstringnullCursor de paginación
sincestringnullFiltro de fecha ISO
statusstringnullFiltro: new, contacted, qualified, converted, lost
urgencystringnullFiltro: low, medium, high
cURL
curl -X GET "https://api.inboundflow.app/v1/leads?status=new" \
  -H "Authorization: Bearer sk_live_your_key_here"

Respuesta

JSON
{
  "data": [
    {
      "id": "uuid",
      "caller_phone": "+1234567890",
      "caller_name": "Dave",
      "caller_email": "dave@example.com",
      "status": "new",
      "urgency": "medium",
      "interest": "auto body work",
      "qualification_reason": "pricing inquiry",
      "call_summary": "Called about getting a quote...",
      "call_log_id": "uuid",
      "contact_id": "uuid",
      "created_at": "2026-02-24T21:00:00Z",
      "updated_at": "2026-02-24T21:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-24T21:05:00Z"
  }
}

📅Citas

Listar todas las citas

GET/v1/appointments

Parámetros de Consulta

ParámetroTipoDefectoDescripción
limitinteger50Resultados por página (defecto: 50, máx: 100)
cursorstringnullCursor de paginación
sincestringnullFiltro de fecha ISO
statusstringnullFiltro: booked, confirmed, cancelled, completed, no_show
cURL
curl -X GET "https://api.inboundflow.app/v1/appointments?status=booked" \
  -H "Authorization: Bearer sk_live_your_key_here"

Respuesta

JSON
{
  "data": [
    {
      "id": "uuid",
      "caller_phone": "+1234567890",
      "caller_name": "Sarah",
      "appointment_date": "2026-02-25",
      "appointment_time_start": "2026-02-25T11:00:00Z",
      "appointment_time_end": "2026-02-25T12:00:00Z",
      "service_type": "Auto Repair Appointment",
      "status": "booked",
      "calendar_event_link": "https://calendar.google.com/...",
      "call_log_id": "uuid",
      "contact_id": "uuid",
      "created_at": "2026-02-24T21:00:00Z",
      "updated_at": "2026-02-24T21:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-24T21:05:00Z"
  }
}

🏢Cuenta

Información de tu organización

GET/v1/me
cURL
curl -X GET "https://api.inboundflow.app/v1/me" \
  -H "Authorization: Bearer sk_live_your_key_here"

Respuesta

JSON
{
  "data": {
    "organization_id": "becc3c5d-1755-420c-a3af-fe51ab2d04ca",
    "organization_name": "Dave Auto Shop",
    "plan": "Starter Plan",
    "scopes": ["calls:read", "contacts:read", "contacts:write", "appointments:read", "leads:read"]
  },
  "meta": {
    "request_id": "req_034e44e17b76",
    "timestamp": "2026-02-24T00:10:48.025Z"
  }
}
Siguiente →
Primeros Pasos