/bbb/businesses

POST /api/bbb/businesses

Price: 5 credits

Get a Better Business Bureau business profile by BBB id (e.g. 0292-1922) or profile URL: name, alternate names, BBB letter rating (A+..F/NR) with reasons, accreditation status, customer star rating, review and complaint counts, categories, entity type, website, address, phone, key contacts, founding dates and the local BBB office.

How to use it

Fetch one BBB business by id (e.g. 0292-1922) or profile URL. Returns name, alt_names (DBA / alternate names), bbb_rating (letter A+..F or NR) with rating_reasons, is_accredited + accredited_at, rating (customer star avg), review_count, complaint_count, closed_complaint_count_3y/12m, categories+category, legal_entity_type (e.g. Corporation), phone, email, web_url, address/city/state/zip_code/formatted_address, latitude/longitude, is_hq, description, contacts (principals and management, each with name/title/is_principal), file_opened_at/business_start_at/incorporated_at, employee_count, years_in_business, is_out_of_business, local_bbb and profile_url.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• business string required — BBB business id (e.g. 0292-1922) or a BBB business profile URL (examples: "0292-1922", "https://www.bbb.org/us/oh/cincinnati/profile/plumber/roto-rooter-plumbing-water-cleanup-0292-1922"; minLength: 1)

Response

• @type string (default: "BbbBusiness")
• id string required
• name string required
• alias string nullable
• alt_names array (default: [])
• bbb_rating string nullable
• rating_reasons array (default: [])
• is_accredited boolean nullable
• accredited_at string nullable
• rating number nullable
• review_count integer nullable
• complaint_count integer nullable
• closed_complaint_count_3y integer nullable
• closed_complaint_count_12m integer nullable
• categories array (default: [])
• category string nullable
• legal_entity_type string nullable
• phone string nullable
• email string nullable
• web_url string nullable
• address string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• formatted_address string nullable
• latitude number nullable
• longitude number nullable
• is_hq boolean nullable
• description string nullable
• contacts array (default: [])
  • @type string (default: "BbbBusinessContact")
  • name string nullable
  • is_principal boolean nullable
• file_opened_at string nullable
• business_start_at string nullable
• incorporated_at string nullable
• employee_count integer nullable
• years_in_business integer nullable
• is_out_of_business boolean nullable
• local_bbb string nullable
• profile_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Business not found (well-formed id with no BBB profile) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.