Get advisory firm

GET /api/v1/advisory-firms/{firm_id}

Get details of a specific advisory firm.

Operation ID: get_firm_api_v1_advisory_firms__firm_id__get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

firm_id string required

Responses

200 Successful Response

Schema: AdvisoryFirmResponse

name string required: Firm name.
address string: Firm business address.
ein string: Tax Employer Identification Number.
logo_url string: URL or S3 key for the firm logo.
stripe_customer_id string: Stripe customer ID for subscription billing.
client_messaging_enabled boolean: Whether clients can use the messaging portal.
ap_automation_enabled boolean: Whether clients see the AP automation bills page in the client portal.
client_visible_integrations array · string: Integration IDs visible to clients in the client portal.
id string required: Advisory firm UUID.
slack_connected boolean: Whether a Slack webhook URL is configured.
slack_webhook_url_masked string: Masked Slack webhook URL (never exposes the full secret).

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

Code samples

GET /api/v1/advisory-firms/{firm_id}

bash

curl -X GET 'https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}", headers=headers)
data = response.json()