List setup links

Get all setup links for a customer

GET /customers/{customer_id}/setup_links

List setup links

cURL

curl --request GET \
  --url https://app.kapso.ai/api/v1/customers/{customer_id}/setup_links \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.kapso.ai/api/v1/customers/{customer_id}/setup_links"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

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

fetch('https://app.kapso.ai/api/v1/customers/{customer_id}/setup_links', 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://app.kapso.ai/api/v1/customers/{customer_id}/setup_links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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://app.kapso.ai/api/v1/customers/{customer_id}/setup_links"

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

	req.Header.Add("X-API-Key", "<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://app.kapso.ai/api/v1/customers/{customer_id}/setup_links")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/customers/{customer_id}/setup_links")

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

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

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

200

{
  "data": [
    {
      "id": "7f8a9b1c-2d3e-4f5a-6b7c-8d9e0f1a2b3c",
      "status": "active",
      "expires_at": "2023-11-07T05:31:56Z",
      "url": "https://app.kapso.ai/whatsapp/setup/aBcD123...",
      "success_redirect_url": "https://your-app.com/whatsapp/success",
      "failure_redirect_url": "https://your-app.com/whatsapp/failed",
      "allowed_connection_types": [
        "coexistence",
        "dedicated"
      ],
      "provision_phone_number": false,
      "phone_number_area_code": "415",
      "phone_number_country_isos": [
        "US"
      ],
      "provisioned_phone_number": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "phone_number": "[phone]",
        "area_code": "415"
      },
      "theme_config": {
        "primary_color": "#3b82f6",
        "primary_foreground_color": "#ffffff",
        "background_color": "#ffffff",
        "text_color": "#0f172a",
        "muted_text_color": "#64748b",
        "card_color": "#f8fafc",
        "muted_color": "#f1f5f9",
        "border_color": "#e2e8f0",
        "secondary_color": "#f1f5f9",
        "secondary_foreground_color": "#0f172a",
        "destructive_color": "#ef4444",
        "destructive_foreground_color": "#fef2f2"
      },
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

{
  "error": "Resource not found"
}

{
  "error": "Resource not found"
}

Authorizations

X-API-Key · string · header · required

Your project API key

Path Parameters

customer_id · string<uuid> · required

Query Parameters

page · integer · default: 1

Required range: x >= 1

per_page · integer · default: 20

Required range: 1 <= x <= 100

Response

200

application/json

List of setup links

data · object[]

Show child attributes

meta · object

Show child attributes