Skip to main content
GET
/
v0
/
tags
/
rules
List all tag rules
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/tags/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "<string>",
      "name": "<string>",
      "tag_id": "<string>",
      "expression": "<string>",
      "priority": 123
    }
  ]
}

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

​
limit
integer
default:50

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

Required range: x >= 1
​
page_token
string | null

Opaque page token

Response

Successful Response

​
next_page_token
string | null
required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

​
prev_page_token
string | null
required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

​
records
TagRule · object[]
required

A list of tag rules.

Example:
[
  {
    "expression": "t.description == 'SHELL GAS'",
    "id": "yB2xokXpQb5S1NgyWsNCwG",
    "name": "Tag gas expense",
    "priority": 10,
    "tag_id": "NCB2xo5S1yQbNgyWskXpwG"
  }
]