Referência da APIFunil
Detalha um funil (com as etapas)
Retorna o funil e suas etapas (nome, cor, regra, posicao no canvas e a ligacao visual proximoStageId). E o que o editor visual carrega. Para a contagem/conversas por etapa, use GET /v1/funnels/{id}/data.
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Path Parameters
id*string
Identificador do funil.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/funnels/string"{
"funnel": {
"id": "string",
"instanceId": "string",
"name": "string"
},
"stages": [
{
"id": "string",
"name": "string",
"color": "gray",
"rule": {
"origin": "any",
"status": "any",
"labelId": "string",
"flowMode": "any",
"flowId": "string",
"nodeId": "string"
},
"posicaoX": 0,
"posicaoY": 0,
"position": 0,
"proximoStageId": "string"
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Instancia nao encontrada"
}
}