Retrieve a pipeline - Kinbox Docs

GET

pipelines

{id}

Retrieve a pipeline

curl --request GET \
  --url https://api4.kinbox.com.br/v1/pipelines/{id} \
  --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": {
    "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.

Path Parameters

string

required

Response

200 - application/json

string

required

name

string

required

Nome do funil

position

number

required

Posição do funil

stages

object[]

required

Estágios do funil

Show child attributes

rules

object[]

required

Regras do funil

Show child attributes

cadence

object[]

Cadência associada ao funil

Show child attributes

lostReasons

string[]

requiredCustomFieldIds

string[]

privacy

object

Show child attributes

authorId

number

Create a pipeline

Retrieve a pipeline

curl --request GET \
  --url https://api4.kinbox.com.br/v1/pipelines/{id} \
  --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": {
    "groupIds": [
      "<string>"
    ],
    "userId": "<string>"
  },
  "authorId": 123
}