List conversation stages
curl --request GET \
--url https://api.salescaptain.com/v1/list-stages/{company_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salescaptain.com/v1/list-stages/{company_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salescaptain.com/v1/list-stages/{company_id}', 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://api.salescaptain.com/v1/list-stages/{company_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.salescaptain.com/v1/list-stages/{company_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.salescaptain.com/v1/list-stages/{company_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salescaptain.com/v1/list-stages/{company_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "Stages fetched successfully!",
"stages": [
{
"stage_id": "d4e5f6a7-0007-4a5b-8c9d-1234567890ab",
"name": "General",
"emoji": null,
"order": 0,
"is_default": true,
"is_spam": false,
"is_lead": false,
"is_lost": false
},
{
"stage_id": "e5f6a7b8-0008-4a5b-8c9d-1234567890ab",
"name": "Job Scheduled",
"emoji": "๐
",
"order": 1,
"is_default": false,
"is_spam": false,
"is_lead": true,
"is_lost": false
}
]
}{
"status": "failure",
"error": "Required parameters missing: company_id"
}{
"error": "Unauthorized access",
"code": "UNAUTHORIZED",
"timestamp": "2023-12-01T10:30:00Z",
"path": "/v1/fetch-companies"
}{
"error": "Forbidden access",
"code": "FORBIDDEN",
"timestamp": "2023-12-01T10:30:00Z",
"path": "/v1/fetch-companies"
}{
"error": "Too many requests, please try again later",
"code": "RATE_LIMIT_EXCEEDED",
"timestamp": "2023-12-01T10:30:00Z",
"path": "/v1/fetch-companies"
}{
"error": "Problem encountered while fetching companies!",
"code": "INTERNAL_ERROR",
"timestamp": "2023-12-01T10:30:00Z",
"path": "/v1/fetch-companies"
}Stages
List conversation stages
Lists the conversation stages (inbox folders) available to the company, ordered as shown in the inbox.
The stage with is_default: true is the default โGeneralโ stage that conversations are in when they
have not been moved anywhere else.
GET
/
v1
/
list-stages
/
{company_id}
List conversation stages
curl --request GET \
--url https://api.salescaptain.com/v1/list-stages/{company_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salescaptain.com/v1/list-stages/{company_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salescaptain.com/v1/list-stages/{company_id}', 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://api.salescaptain.com/v1/list-stages/{company_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.salescaptain.com/v1/list-stages/{company_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.salescaptain.com/v1/list-stages/{company_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salescaptain.com/v1/list-stages/{company_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "Stages fetched successfully!",
"stages": [
{
"stage_id": "d4e5f6a7-0007-4a5b-8c9d-1234567890ab",
"name": "General",
"emoji": null,
"order": 0,
"is_default": true,
"is_spam": false,
"is_lead": false,
"is_lost": false
},
{
"stage_id": "e5f6a7b8-0008-4a5b-8c9d-1234567890ab",
"name": "Job Scheduled",
"emoji": "๐
",
"order": 1,
"is_default": false,
"is_spam": false,
"is_lead": true,
"is_lost": false
}
]
}{
"status": "failure",
"error": "Required parameters missing: company_id"
}{
"error": "Unauthorized access",
"code": "UNAUTHORIZED",
"timestamp": "2023-12-01T10:30:00Z",
"path": "/v1/fetch-companies"
}{
"error": "Forbidden access",
"code": "FORBIDDEN",
"timestamp": "2023-12-01T10:30:00Z",
"path": "/v1/fetch-companies"
}{
"error": "Too many requests, please try again later",
"code": "RATE_LIMIT_EXCEEDED",
"timestamp": "2023-12-01T10:30:00Z",
"path": "/v1/fetch-companies"
}{
"error": "Problem encountered while fetching companies!",
"code": "INTERNAL_ERROR",
"timestamp": "2023-12-01T10:30:00Z",
"path": "/v1/fetch-companies"
}
