List conversation profiles

Retrieves all conversation profiles associated with a specific company. Conversation profiles represent communication channels like phone lines, email addresses, etc.

GET /v1/list-conversation-profiles/{company_id}

List conversation profiles for a company

cURL

curl --request GET \
  --url https://api.salescaptain.com/v1/list-conversation-profiles/{company_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.salescaptain.com/v1/list-conversation-profiles/{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-conversation-profiles/{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-conversation-profiles/{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-conversation-profiles/{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-conversation-profiles/{company_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.salescaptain.com/v1/list-conversation-profiles/{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

200

{
  "message": "Conversation profiles fetched successfully!",
  "account": [
    {
      "conversation_profile_id": "cp-1111-2222-3333-444455556666",
      "name": "Main Line",
      "number": "[phone]",
      "email": "[e-mail]",
      "color": "#4A90D9"
    },
    {
      "conversation_profile_id": "cp-7777-8888-9999-aaaabbbbcccc",
      "name": "Sales Line",
      "number": "[phone]",
      "email": "[e-mail]",
      "color": "#50C878"
    },
    {
      "conversation_profile_id": "cp-dddd-eeee-ffff-000011112222",
      "name": "Email Channel",
      "number": null,
      "email": "[e-mail]",
      "color": "#FF6B6B"
    }
  ]
}

{
  "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"
}

Authorizations

Authorization · string · header · required

Authentication token required for accessing protected endpoints. The token should be obtained from the main SalesCaptain authentication service.

Path Parameters

company_id · string<uuid> · required

Unique identifier for the company

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

200

application/json

Conversation profiles fetched successfully

message · string

Example:

"Conversation profiles fetched successfully!"

account · object[]

Show child attributes