List firm businesses — advisory-firms

Parameters

Path

firm_id string required

Query

cursor string

Cursor for pagination

limit integer

Pagination limit

direction string default: next

Pagination direction: 'next' or 'prev'

include_total_count boolean default: False

Whether to include total count (expensive - avoid if possible)

sort_by string

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descending boolean default: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

200 Successful Response

Schema: FirmBusinessesCursorResponse

items array · BusinessResponse requiredBusinessResponse

List of items

27 fields

id string: Business UUID.
firm_id string: Advisory firm UUID this business belongs to.
mailbox string: Email prefix for bill forwarding.
name string: Business name.
logo_url string: URL to business logo/avatar image.
default_currency string: Default currency for the business (USD, CAD, AUD, EUR, or GBP).
tax_year_end_month integer: Month when the tax/fiscal year ends (1-12). 12 = calendar year.
tax_year_display string: Human-readable tax year description (e.g., 'Calendar Year (Jan-Dec)').
created_at string · date-time: Creation timestamp.
updated_at string · date-time: Last update timestamp.
teal_instance_id string: Teal instance ID (API format).
teal_instance string: Teal database ID.
entries_start string · date-time: Start date for transaction imports.
stripe_account_id string: Connected Stripe account ID.
stripe_subscription_id string: Stripe subscription ID.
stripe_customer_id string: Stripe customer ID.
subscription_items object: Stripe subscription items/products linked to this business.
shopify_shop_domain string: Connected Shopify domain.
shopify_access_token_id string: Shopify token UUID.
ramp_connection_id string: Ramp connection UUID.
square_connection_id string: Square connection UUID.
finch_connection_id string: Finch payroll connection UUID.
hubspot_connection_id string: HubSpot connection UUID.
plaid_connections array · PlaidConnectionSchema: Connected bank accounts via Plaid.
slack_connected boolean: Whether a Slack webhook URL is configured.
sync SyncStatus: Teal sync status.
inventory_mode string: Inventory module flavor: 'cpg' or 'finished_goods'.

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object