CRM
Obtener una oportunidad
Devuelve el registro de una oportunidad: el resumen más la descripción, los colaboradores y los presupuestos vinculados.
Ejemplos de petición
curl https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
Con includeHistory=true añade stageHistory, los cambios de etapa del más reciente al más antiguo: es una consulta adicional, así que no viene por defecto.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. crm:read
Cabeceras
Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.
Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Parámetros de ruta
Identificador de la oportunidad.
Límites: longitud mín. 1
Respuesta
Respuesta correcta.
Esquema de la respuesta: OpportunityDetailDto
Sobre: OpportunityDetailResponse. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
Detalle completo de una oportunidad del CRM.
Mostrar atributos hijosOcultar atributos hijos
Opciones disponibles: open, won, lost
Opciones disponibles: open, won, lost
Opciones disponibles: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other
Límites: mín. 1
Mostrar atributos hijosOcultar atributos hijos
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
No modificado: el If-None-Match enviado coincide con el ETag actual. Sin cuerpo; la copia que tienes está al día.
Cabeceras: ETag
Sin cuerpo.
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language
Add-on requerido (addon_required): el plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en requiredScope; forbidden: el propietario de la clave carece del permiso que exige la operación). insufficient_scope se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras RateLimit-*; forbidden sí.
Cabeceras: X-Request-Id · Content-Language
Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 402 | addon_required | El plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra. |
| 404 | not_found | No existe o queda fuera del alcance de la clave de API. |
401, 403, 429, 500 los puede devolver cualquier operación. Errores
Obsolescencia
Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones
Relacionado
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasCRM
Oportunidad
Oportunidad del CRM: en qué embudo y etapa está, por cuánto, con quién y con qué probabilidad.
¿Te ha resultado útil esta página?