Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.redbark.co/llms.txt

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

The REST API is in beta. This endpoint’s response shape may change.
Returns the list of transaction categories that Redbark assigns to transactions. Categories are derived from CDR enrichment data provided by the banking provider. Use this endpoint to build category mapping configurations for tools like Sure sync and Actual Budget sync.

Request

GET /v1/categories

Headers

HeaderRequiredDescription
AuthorizationYesBearer YOUR_API_KEY
Trialing customers retain full API access.

Response headers

HeaderDescription
X-CacheHIT, MISS, or BYPASS. Set unconditionally by the cache layer.

Caching

Cached at the edge for 1 hour (this is a static enum list).

Response

{
  "categories": [
    { "key": "BANK_FEES", "label": "Bank Fees" },
    { "key": "ENTERTAINMENT", "label": "Entertainment" },
    { "key": "FOOD_AND_DRINK", "label": "Food & Drink" },
    { "key": "GOVERNMENT_AND_NON_PROFIT", "label": "Government & Non-Profit" },
    { "key": "HOME_IMPROVEMENT", "label": "Home Improvement" },
    { "key": "INCOME", "label": "Income" },
    { "key": "LOAN_PAYMENTS", "label": "Loan Payments" },
    { "key": "MEDICAL", "label": "Medical" },
    { "key": "MERCHANDISE", "label": "Merchandise" },
    { "key": "PERSONAL_CARE", "label": "Personal Care" },
    { "key": "RENT_AND_UTILITIES", "label": "Rent & Utilities" },
    { "key": "SERVICES", "label": "Services" },
    { "key": "TRANSFER_IN", "label": "Transfer In" },
    { "key": "TRANSFER_OUT", "label": "Transfer Out" },
    { "key": "TRANSPORTATION", "label": "Transportation" },
    { "key": "TRAVEL", "label": "Travel" }
  ]
}

Category object

FieldTypeDescription
keystringInternal category identifier (e.g. FOOD_AND_DRINK)
labelstringHuman-readable category name (e.g. Food & Drink)
The key matches the category field returned on transaction objectskey is the raw uppercase code (e.g. FOOD_AND_DRINK); label is the matching human-readable name (e.g. Food & Drink), provided here for display.

Error responses

Errors use the standard envelope { "error": { "message": string, "code"?: string, "details"?: string[] } }.
StatusWhen
401Missing or invalid bearer token
403API access requires a Developer or Professional plan. Trialing customers retain API access regardless of plan.
429Rate limit exceeded (cheap bucket). See Retry-After and X-RateLimit-Reset.

Example

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.redbark.co/v1/categories"