List Cost Category Keyword Aliases
GET/api/cost-category-keyword-aliases
List active cost-category keyword aliases used by the OCR cost-line matcher. Returns an object keyed by cost_category_id with arrays of keyword strings. Used by the Settings page that lets users curate which keywords (e.g., "freight", "fuel surcharge", "customs", "duty", "clearance") map to which CostCategory.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Keywords feed Tier 4 (keyword) of the 6-tier match cascade in the OCR manager.
Response 200:
{
"data": {
"4": ["freight", "shipping", "fuel surcharge", "airfreight"],
"5": ["customs", "duty", "clearance", "import duty"],
"6": ["insurance", "cargo insurance"]
}
}
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.