Skip to main content
GET
/
v1
/
pipelines
List all pipelines
curl --request GET \
  --url https://api4.kinbox.com.br/v1/pipelines \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "position": 123,
    "stages": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "<string>",
        "requireds": [
          "<string>"
        ]
      }
    ],
    "rules": [
      {
        "ruleId": "<string>",
        "max": 123,
        "stageId": "<string>"
      }
    ],
    "cadence": [
      {
        "stageId": "<string>",
        "task": {},
        "id": "<string>"
      }
    ],
    "lostReasons": [
      "<string>"
    ],
    "requiredCustomFieldIds": [
      "<string>"
    ],
    "privacy": {
      "type": "private",
      "groupIds": [
        "<string>"
      ],
      "userId": "<string>"
    },
    "authorId": 123
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
id
string
required
name
string
required

Nome do funil

position
number
required

Posição do funil

stages
object[]
required

Estágios do funil

rules
object[]
required

Regras do funil

cadence
object[]

Cadência associada ao funil

lostReasons
string[]
requiredCustomFieldIds
string[]
privacy
object
authorId
number