Get a Business
Returns the published Business projection anonymously. A signed-in user token or Workspace API key, together with SMB-Workspace-Id, returns that Workspace's authorized Business projection instead.
AuthorizationBearer <token>A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.
business_id*string1 <= length <= 128fields?array<>items <= 200max_age?integerOptional, in seconds (86400 = a day). Values older than this are still returned, listed in stale, and re-checked first. Age is from a value's own as_of, otherwise from as_of.
0 <= value <= 315360000max_credits?integerOptional cap on the credits this call may charge (1,000,000 = $1.00). If it would cost more, nothing is charged and the call fails with budget_exceeded, saying how many credits it needs.
0 <= value <= 100000000revision?string1 <= length <= 200SMB-Workspace-Id?stringRequired when requesting an authenticated Workspace projection.
uuidPublic Business data for anonymous callers, or the authorized Workspace projection for a valid Workspace API key.
application/json- response
as_of*smb_v0_operations_get_business_response.__local.Timestampdate-timedata*effective_at?stringBusiness-effective point used for this result when requested.
date-timelinks?pending?array<>The fields asked for (list_fields keys) that have no value yet and are being researched. Read again later.
items <= 60projection*stringrequest_id*SmbV0OperationsGetBusinessRequestRevision1 <= length <= 200schema_hash*smb_v0_operations_get_business_response.__local.Digest^sha256:[0-9a-f]{64}$schema_version*string1 <= length <= 100stale?array<>With max_age: the fields (list_fields keys) whose value is older than max_age. Their values are returned and re-checked first.
items <= 60usage?Credits this call used, from the same transaction as any charge. 1,000,000 credits = $1.00. Paid fields cost credits only when a value comes back that this Workspace hasn't unlocked; an unlock lasts 12 months.
curl -X GET 'https://example.com/v1/businesses/string'{ "as_of": "2019-08-24T14:15:22Z", "data": { "acquisition": { "status": "off_market", "note": "string", "sellable": true, "not_sellable_reason": "government", "listings": [], "financing": { "sba": { "eligible_industry": true, "max_rate_percent": 0, "prime_rate_percent": 0, "rates_as_of": "2019-08-24", "term_years": 1, "min_down_percent": 0 }, "example": { "price": 0, "down_percent": 0, "cash_down": 0, "loan_amount": 0, "rate_percent": 0, "term_years": 1, "monthly_payment": 0, "annual_debt_service": 0, "owner_salary": 0, "cash_left_after_debt": -1000000000000, "coverage_ratio": -1000, "lender_minimum": 0, "meets_lender_minimum": true } }, "confidence": 0, "method": "modeled" }, "brand": { "id": "string", "name": "string", "type": "franchise", "website_url": "string", "location_count": 1, "franchise": { "sba": { "eligible": true, "code": "string", "listed_on": "2019-08-24" }, "initial_fee_usd": { "low": 0, "high": 0 }, "royalty_percent": 0, "marketing_fund_percent": 0, "total_investment_usd": { "low": 0, "high": 0 }, "units": { "franchised": 0, "company_owned": 0, "year": 0 }, "discloses_earnings": true, "term_years": 1, "franchising_since": 0, "disclosure_year": 0 } }, "certifications": [ "string" ], "city": "string", "closed_on": "2019-08-24", "community": { "demographics": { "tract": { "total_population": 0, "median_household_income": 0, "per_capita_income": 0, "poverty_rate": 0, "unemployment_rate": 0, "bachelors_plus_rate": 0, "broadband_subscription_rate": 0, "uninsured_rate": 0, "limited_english_rate": 0, "median_age": 0, "median_home_value": 0, "owner_occupied_housing_rate": 0, "vacancy_rate": 0, "total_housing_units": 0, "self_employed_rate": 0, "mean_commute_time": 0, "year": 2000 }, "zip": { "total_population": 0, "median_household_income": 0, "per_capita_income": 0, "poverty_rate": 0, "unemployment_rate": 0, "bachelors_plus_rate": 0, "broadband_subscription_rate": 0, "uninsured_rate": 0, "limited_english_rate": 0, "median_age": 0, "median_home_value": 0, "owner_occupied_housing_rate": 0, "vacancy_rate": 0, "total_housing_units": 0, "self_employed_rate": 0, "mean_commute_time": 0, "year": 2000 }, "county": { "total_population": 0, "median_household_income": 0, "per_capita_income": 0, "poverty_rate": 0, "unemployment_rate": 0, "bachelors_plus_rate": 0, "broadband_subscription_rate": 0, "uninsured_rate": 0, "limited_english_rate": 0, "median_age": 0, "median_home_value": 0, "owner_occupied_housing_rate": 0, "vacancy_rate": 0, "total_housing_units": 0, "self_employed_rate": 0, "mean_commute_time": 0, "average_annual_pay": 0, "year": 2000 } } }, "country_code": "US", "description": "string", "financials": { "estimated": { "revenue": { "estimate": 0, "low": 0, "high": 0 }, "payroll": 0, "cash_flow": 0, "confidence": 0, "year": 2000, "method": "modeled" } }, "founded_on": "2019-08-24", "hours": "string", "id": "string", "legal_entity": { "type": "llc", "status": "active", "good_standing": true }, "logo": { "url": "http://example.com", "method": "researched" }, "market": { "owner_age": { "under_35_percent": 0, "age_35_to_54_percent": 0, "age_55_to_64_percent": 0, "age_65_plus_percent": 0, "age_55_plus_percent": 0, "year": 2000 }, "openings_and_closings": { "opening_rate_percent": 0, "closing_rate_percent": 0, "year": 2000 }, "ownership_mix": { "women_owned_percent": 0, "minority_owned_percent": 0, "hispanic_owned_percent": 0, "veteran_owned_percent": 0, "year": 2000 }, "competition": { "same_industry_businesses_county": 0, "industry_level": "industry", "per_10k_residents": 0, "state_per_10k_residents": 0, "saturation": "underserved", "method": "counted" } }, "naics_code": "string", "naics_name": "string", "naics_title": "string", "naics_vintage": "1997", "name": "string", "not_a_business": true, "operations": { "sells_online": true, "online_booking": true, "serves_at_customer_location": true, "emergency_service": true, "free_estimates": true, "financing_offered": true, "licensed_insured": true, "method": "researched" }, "ownership": { "legal_name": { "name": "string", "method": "researched" }, "type": { "family_owned": true, "family_generation": 2, "owner_operated": true, "locally_owned": true, "veteran_owned": true, "woman_owned": true, "minority_owned": true, "employee_owned": true, "method": "researched" }, "succession": { "owner_age_band": { "band": "under_35", "likelihood": 0, "method": "modeled" }, "risk": { "level": "low", "score": 0, "confidence": 0, "method": "modeled" } } }, "place": { "zip": "string", "county": "string", "county_fips": "string", "census_tract": "string", "state_fips": "string", "area_type": "metro", "metro_area": "string", "cbsa_code": "string", "central_county": true, "opportunity_zone": true, "tract_income_level": "low" }, "primary_classification_id": "string", "primary_location_id": "string", "public_phone": "string", "publication_status": "published", "published_at": "2019-08-24T14:15:22Z", "service_area": [ "string" ], "services": [ "string" ], "social_profiles": { "facebook": "http://example.com", "instagram": "http://example.com", "linkedin": "http://example.com", "x": "http://example.com", "youtube": "http://example.com", "tiktok": "http://example.com", "pinterest": "http://example.com", "threads": "http://example.com", "yelp": "http://example.com", "google": "http://example.com", "nextdoor": "http://example.com", "bbb": "http://example.com", "houzz": "http://example.com", "angi": "http://example.com", "thumbtack": "http://example.com", "tripadvisor": "http://example.com", "opentable": "http://example.com", "method": "researched" }, "state": "string", "status": "active", "team": { "employees": { "band": "1-4", "estimate": 1, "low": 1, "high": 1, "confidence": 0, "method": "modeled" }, "makeup": { "full_time": true, "part_time": true, "seasonal": true, "contractors": true, "hiring": true, "method": "researched" } }, "technology": { "website": [ "string" ], "ecommerce": [ "string" ], "crm": [ "string" ], "forms": [ "string" ], "booking": [ "string" ], "field_service": [ "string" ], "ordering": [ "string" ], "payments": [ "string" ], "reviews": [ "string" ], "chat": [ "string" ], "marketing": [ "string" ], "analytics": [ "string" ], "advertising": [ "string" ], "hiring": [ "string" ], "payroll": [ "string" ], "method": "researched" }, "value": { "estimate": { "low": 0, "likely": 0, "high": 0 }, "currency": "string", "confidence": 0, "as_of": "2019-08-24", "model_version": "string", "method": "modeled" }, "website_status": "live", "website_url": "string", "years_in_business": { "band": "0-2", "estimate": 0, "confidence": 0, "method": "modeled" } }, "effective_at": "2019-08-24T14:15:22Z", "links": { "property1": "../dictionary", "property2": "../dictionary" }, "pending": [ "string" ], "projection": "public", "request_id": "string", "schema_hash": "string", "schema_version": "string", "stale": [ "string" ], "usage": { "credits_charged": 0, "credits_remaining": 0, "unit": "usd_micro", "unlocked_until": "2019-08-24T14:15:22Z" }}