Skip to content

Mercury: List all categories

Mercury categories.listCategories: arguments, response, policy and SDK examples.

← Categories operations · Get started

Operation mercury.listcategories

Provider route: GET /categories. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["categories"]["listCategories"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.categories.listCategories(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_mercury import MercuryIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.categories.list_categories(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’
Default: asc
One of: asc, desc
query.start_afterstringOptionalThe ID of the category to start the page after (exclusive). When provided, results will begin with the category immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
Format: uuid
query.end_beforestringOptionalThe ID of the category to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
Format: uuid

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List all categories — response body

Referenced models: List all categories — response body

List all categories — response body
FieldTypePresenceDescription and constraints
$objectRootPaginated response containing a list of categories.
| Use the page cursor information to fetch additional pages of categories.
categoriesarrayRequired within parentList of categories in the current page
categories[]ModelEach itemExpand Edit a category — response body
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the category
Format: uuid
page.previousPagestringOptionalID for the category
Format: uuid

Referenced models: Edit a category — response body

Edit a category — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents an expense category for transaction classification.
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the category
Format: uuid
id (allOf 2)JSONAll variants applyThe ID of the category
namestringRequired within parentThe name of the category
visibleForCardSpendbooleanRequired within parentWhether this category is applicable to card transactions
visibleForOtherbooleanRequired within parentWhether this category is applicable to all other transaction kinds
visibleForReimbursementsbooleanRequired within parentWhether this category is applicable to expense reimbursement transactions

SDK function policy ID: mercury.listcategories. Catalog operation: mercury:listCategories. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.