Skip to main content
GET
/
configuration
Returns the client configuration
curl --request GET \
  --url https://api.sandbox.goteal.co/configuration \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.sandbox.goteal.co/configuration"

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://api.sandbox.goteal.co/configuration', 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.sandbox.goteal.co/configuration",
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://api.sandbox.goteal.co/configuration"

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://api.sandbox.goteal.co/configuration")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.goteal.co/configuration")

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
{
  "payslip_upload_enabled": true,
  "payroll_period_months": 24,
  "client_logo": "image.png",
  "client_callback_url": "https://app.client.com/callback",
  "recurring_checks_enabled": true,
  "recurring_check_frequency": "WEEKLY",
  "recurring_check_end_date": "2019-05-17T00:00:00.000Z",
  "payroll_connections_enabled": true,
  "client_display_name": "Acme Corporation"
}
{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}
{
"errors": [
"The resource with id [8be3bb60-5ab4-4bd2-90e6-3b015691a827] does not exist"
]
}

Authorizations

X-API-KEY
string
header
required

Response

OK

payslip_upload_enabled
boolean

Determines if payslip upload via documents is allowed as a fallback if there is not connection to payroll providers

Example:

true

payroll_period_months
integer<int32>

Lookback period of the payroll to search on account creation

Example:

24

Client logo asset or URL

Example:

"image.png"

client_callback_url
string

Callback URL for client application. This will be redirected to once the user completes their journey on Teal's platform

Example:

"https://app.client.com/callback"

recurring_checks_enabled
boolean

Determines if recurring checks are enabled client-wide

Example:

true

recurring_check_frequency
string

Frequency of the recurring check for the client. Available frequencies in production are [WEEKLY, MONTHLY]. Sandbox allows HOURLY frequency in addition.

Example:

"WEEKLY"

recurring_check_end_date
string<date-time>

End date of the recurring check schedule client-wide

Example:

"2019-05-17T00:00:00.000Z"

payroll_connections_enabled
boolean

Determines if payroll connections feature is enabled for this client. When disabled, the payroll connections endpoint will return an error.

Example:

true

client_display_name
string | null

Editable display name for the client. This can be customized and is separate from the internal client name.

Example:

"Acme Corporation"