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>'
{
  "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-5f6g-7h8i-9j0k1l2m3n4o",
      "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"
    }
  ]
}

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[]