Skip to main content
GET
Retrieve a tag rule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Headers

teal-instance-id
string
required

The teal instance ID

Path Parameters

tag_rule_id
string
required

The tag ID

Response

Successful Response

id
string
required

The unique ID of the object.

Example:

"yB2xokXpQb5S1NgyWsNCwG"

name
string
required

An arbitrary string, useful for identifying the tag rule.

Example:

"Tag gas expense"

tag_id
string
required

If the rule finds a match, the ID of the tag that will be assigned.

Example:

"NCB2xo5S1yQbNgyWskXpwG"

expression
string
required

A pattern matching expression using the match(pattern, field) function. Use t to access the Transaction object. The pattern supports regular expression syntax.

Read more: Categorization guide

Example:

"match(\".*(?i)SHELL GAS\", t.description)"

priority
integer
required

The priority of the rule.

Example:

10