List pipeline stages - Voxys Connect Developer Docs

GET

api

accounts

{account_id}

funnels

{id}

stages

List pipeline stages

curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages \
  --header 'api_access_token: <api-key>'

import requests

url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages"

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_access_token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages")
  .header("api_access_token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 7,
    "funnel_id": 3,
    "name": "Qualification",
    "color": "#2196F3",
    "position": 2,
    "chatwoot_status": "open",
    "cards_count": 8,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

{
  "error": "Unauthorized"
}

{
  "error": "Unauthorized"
}

Authorizations

api_access_token

string

header

required

API access token for authentication. Obtain from your Voxys Connect profile settings.

Path Parameters

account_id

integer

required

The numeric ID of the account.

integer

required

The ID of the pipeline.

Response

List of stages.

integer

Example:

7

funnel_id

integer

Example:

3

name

string

Example:

"Qualification"

color

string | null

Example:

"#2196F3"

position

integer

Example:

2

chatwoot_status

enum<string> | null

Available options:

open,

resolved,

pending,

null

Example:

"open"

cards_count

integer

Example:

8

created_at

string<date-time>

updated_at

string<date-time>

Create a pipeline stageAdds a new stage to a pipeline.

List pipeline stages

curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages \
  --header 'api_access_token: <api-key>'

import requests

url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages"

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_access_token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages")
  .header("api_access_token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/stages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 7,
    "funnel_id": 3,
    "name": "Qualification",
    "color": "#2196F3",
    "position": 2,
    "chatwoot_status": "open",
    "cards_count": 8,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

{
  "error": "Unauthorized"
}

{
  "error": "Unauthorized"
}