Skip to main content
GET
/
v1
/
pipelines
List pipelines
curl --request GET \
  --url https://api.vendaze.com/v1/pipelines \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "New Business",
      "created_at": "2023-11-07T05:31:56Z",
      "stages": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Proposal",
          "probability": 40,
          "created_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "per_page": 50,
    "has_more": false
  }
}

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
per_page
integer
default:50

Number of records per page. Maximum: 100.

Required range: 1 <= x <= 100
order_by
enum<string>
default:created_at

Field to sort by.

Available options:
created_at,
name
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

Pipelines listed successfully.

data
object[]
meta
object