CRM

Obtener un embudo

Devuelve un embudo por su identificador, con sus etapas ordenadas y su tipo (open, won o lost).

GET
/api/v1/crm/pipelines/{pipelineId}

Ejemplos de petición

curl https://app.filmo.io/api/v1/crm/pipelines/pipe_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": {
    "pipelineId": "pipeline_9f3a2b",
    "name": "Example pipeline",
    "slug": "Example slug",
    "isDefault": true,
    "isArchived": true,
    "totalOpportunities": 1,
    "totalValue": "120.00",
    "stages": [
      {
        "stageId": "stage_9f3a2b",
        "name": "Example stage",
        "order": 1,
        "type": "open",
        "probability": 1,
        "isDefault": true
      }
    ],
    "createdAt": "2026-09-01T10:00:00+02:00",
    "updatedAt": "2026-09-01T10:00:00+02:00"
  }
}

Generado a partir del esquema

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. crm:read

Cabeceras

If-None-Matchstring

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

pipelineIdstringObligatorio

Identificador del embudo.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: PipelineDto

Sobre: PipelineResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

Embudo del CRM con sus etapas ordenadas y, opcionalmente, el recuento y el valor total de sus oportunidades.

Mostrar atributos hijos
data.pipelineIdstring

data.namestring

data.slugstring

data.isDefaultboolean

data.isArchivedboolean

data.totalOpportunitiesinteger

data.totalValuestring

data.stagesobject[]

Mostrar atributos hijos
data.stages.stageIdstring

data.stages.namestring

data.stages.orderinteger

data.stages.typestring

Opciones disponibles: open, won, lost

data.stages.probabilitynumber

data.stages.isDefaultboolean

data.createdAtstring<date-time>

data.updatedAtstring<date-time>

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
402addon_requiredEl plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.
404not_foundNo 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

  • CRM

    Embudo

    Embudo del CRM con sus etapas ordenadas y, opcionalmente, el recuento y el valor total de sus oportunidades.

¿Te ha resultado útil esta página?