Skip to main content
GET
List categorization rules

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[]
required
meta
object

Request metadata. Present on paginated list responses.