Skip to main content
GET
/
api
/
v1
/
sms
/
settings
Get SMS Settings
curl --request GET \
  --url https://api.sequenzy.com/api/v1/sms/settings \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.sequenzy.com/api/v1/sms/settings"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/sms/settings', 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.sequenzy.com/api/v1/sms/settings",
  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.sequenzy.com/api/v1/sms/settings"

	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.sequenzy.com/api/v1/sms/settings")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/sms/settings")

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
{
  "success": true,
  "sms": {
    "enabled": true,
    "planEligible": true,
    "creditsBalance": 4200,
    "brandPrefix": "Acme",
    "numbers": [{ "e164": "+18885550123", "status": "active" }],
    "readyToSend": true
  },
  "message": "SMS is enabled and ready to send."
}

{
  "error": "Invalid API key"
}

{
  "error": "Company not found"
}

{
  "error": "Failed to load SMS settings"
}

​
Get SMS Settings

Returns the company’s SMS add-on status: whether SMS is enabled, plan eligibility, credit balance, brand prefix, phone numbers, and whether SMS sequence steps will actually send. Check this before adding SMS steps to sequences. Steps added while SMS is not ready are stored normally but skip at runtime until the add-on is enabled and a number is active.

​
Request

No request body. Pass X-Company-Id if your API key has access to multiple companies. 
curl "https://api.sequenzy.com/api/v1/sms/settings" \
  -H "Authorization: Bearer seq_live_xxx"

​
Responses

{
  "success": true,
  "sms": {
    "enabled": true,
    "planEligible": true,
    "creditsBalance": 4200,
    "brandPrefix": "Acme",
    "numbers": [{ "e164": "+18885550123", "status": "active" }],
    "readyToSend": true
  },
  "message": "SMS is enabled and ready to send."
}

{
  "error": "Invalid API key"
}

{
  "error": "Company not found"
}

{
  "error": "Failed to load SMS settings"
}