Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
categorization-rules
List categorization rules
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "category": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "suggestion_1": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "suggestion_2": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "suggestion_3": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "merchant_type_filter": "<string>",
      "transaction_description_filter": "<string>",
      "counterparty_filter": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "logo_url": "<string>",
        "website": "<string>"
      },
      "bank_transaction_type_filter": "REVENUE",
      "bank_direction_filter": "MONEY_IN",
      "amount_min_filter": 123,
      "amount_max_filter": 123
    }
  ],
  "pagination": {
    "sort_by": "<string>",
    "sort_order": "ASC",
    "cursor": "<string>",
    "has_more": true,
    "total_count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
Authorization
string
header
required

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

Headers

ā€‹
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

ā€‹
businessId
string<uuid>
required

The UUID of the business.

Query Parameters

ā€‹
include_archived
boolean
default:false

Include archived rules in the response (default: false).

ā€‹
external_ids
string

Comma-separated list of external IDs to filter by.

ā€‹
limit
integer

Maximum number of results per page.

ā€‹
sort_by
string
default:created_at

Field to sort by (default: created_at).

ā€‹
sort_order
enum<string>

Sort order (ASC or DESC).

Available options:
ASC,
DESC
ā€‹
pagination_cursor
string

Pagination cursor for fetching next page.

Response

200 - application/json

List of categorization rules.

ā€‹
data
object[]
ā€‹
pagination
object

Cursor-based pagination metadata returned alongside paginated list responses.