Skip to main content
GET
/
authorisations
/
terms
List all authorisation terms.
curl --request GET \
  --url https://api.sandbox.goteal.co/authorisations/terms \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.sandbox.goteal.co/authorisations/terms"

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/authorisations/terms', 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/authorisations/terms",
  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/authorisations/terms"

	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/authorisations/terms")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

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

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
{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "count": 2
  },
  "terms": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Teal Data Sharing Agreement",
      "authorisation_text": "I agree to share my payroll data with the lender for income verification.",
      "authorisation_version": 1,
      "authorisation_category": "recurring",
      "is_active": true,
      "is_system_term": true,
      "created_at": "2024-01-15T00:00:00.000Z"
    },
    {
      "id": "7f3b8c2a-1d4e-4f6a-8b8c-9a0b1c2d3e4f",
      "name": "Custom Terms v2",
      "authorisation_text": "Custom authorisation text for our lending product.",
      "authorisation_version": 2,
      "authorisation_category": "one_time",
      "is_active": true,
      "is_system_term": false,
      "created_at": "2024-06-01T00:00:00.000Z"
    }
  ]
}
{
  "errors": [
    "The request is missing the required field `name`"
  ]
}
{
  "errors": [
    "No X-API-KEY header provided or wrong value"
  ]
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

authorisation_category
enum<string>

Filter by authorisation category The category of authorisation

Available options:
one_time,
recurring
Example:

"one_time"

is_active
boolean

Filter by active status

is_system_term
boolean

Filter by system term status. True returns only Teal's default terms, false returns only client-created terms.

offset
integer<int32>
default:0

The offset to start at

Required range: x >= 0
limit
integer<int32>
default:20

The number of items to return

Required range: 1 <= x <= 100

Response

OK

pagination
object
terms
object[]