Get v1sub client - Terminal 3 Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

curl --request GET \
  --url https://staging.terminal3.io/v1/sub_client \
  --header 'x-api-token: <x-api-token>'

Python

import requests

url = "https://staging.terminal3.io/v1/sub_client"

headers = {"x-api-token": "<x-api-token>"}

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

print(response.text)

JavaScript

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

fetch('https://staging.terminal3.io/v1/sub_client', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.terminal3.io/v1/sub_client",
  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-token: <x-api-token>"
  ],
]);

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

curl_close($curl);

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

Go

package main

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

func main() {

url := "https://staging.terminal3.io/v1/sub_client"

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

req.Header.Add("x-api-token", "<x-api-token>")

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

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

fmt.Println(string(body))
}

Unirest (Java)

HttpResponse<String> response = Unirest.get("https://staging.terminal3.io/v1/sub_client")
  .header("x-api-token", "<x-api-token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://staging.terminal3.io/v1/sub_client")

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

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

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

Response Codes

Example Response

{
  "data": [
    {
      "client_id": 123,
      "name": "<string>",
      "domain": "<string>",
      "timezone": "<string>",
      "address_1": "<string>",
      "address_2": "<string>",
      "country": "<string>",
      "province": "<string>",
      "city": "<string>",
      "subdomain": "<string>",
      "from_email_address": "<string>",
      "esp_token": "<string>",
      "recaptcha_key": "<string>",
      "recaptcha_threshold": 123,
      "recaptcha_enabled": true,
      "created_at": "<string>",
      "privacy_link": "<string>"
    }
  ],
  "per_page": 123,
  "current_page": 123,
  "total_pages": 123
}

Error Response Example

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Headers

x-api-token

Query Parameters

Response