GET
/
v0
/
categorization
/
rules
List all Instance rules
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/categorization/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "N6ntpvTtiA4L31vVyVat5n",
      "expression": "t.description == 'SHELL GAS'",
      "ledger_name": "Fuel Expenses",
      "name": "Shell to Fuel Expenses",
      "priority": "100"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
teal-instance-id
string
required

The Teal instance ID

Query Parameters

​
name
string | null

The name of the rule for filtering.

​
ledger_name
string | null

The ledger name for filtering.

​
sort
enum<string>[] | null

A comma separated list of sort orders for the results.

​
limit
integer | null
default:50

The number of records to return. Max limit is 1000.

Required range: 1 <= x < 1001
​
page_token
string | null

Response

Successful Response

​
next_page_token
string | null
required

The token to use to request the next page

Examples:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

​
prev_page_token
string | null
required

The token to use to request the previous page

Examples:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

​
records
CategorizationRule · object[]
required

The categorization rule objects