Skip to content
SimplifyLocalDocs
Sign in to the app

Business descriptor

GET /api/businesses/{slug}

Returns the business on its own: name, contact details, branding, the named author shown on pages, and the path configuration your routes need to match. The same object is embedded as business in every List jobs and Get a job response, so you only need this endpoint when you want the descriptor without any jobs.

Terminal window
curl https://app.simplifylocal.app/api/businesses/{slug} \
  -H "Authorization: Bearer sl_live_…"

There are no query parameters.

Response

Section titled “Response”

200 OK, a single Business:

{
  "slug": "alpha-pressure-washing",
  "name": "Alpha Pressure Washing",
  "phone": "+14045550123",
  "primary_service_area": "Marietta, GA",
  "primary_vertical": "pressure-washing",
  "industry_label": null,
  "canonical_domain": "https://example.com",
  "jobs_base_path": "/work",
  "service_path_pattern": "/services/{slug}",
  "location_path_pattern": "/service-areas/{slug}",
  "category_index_paths": {
    "by_service": "/work/services/{slug}",
    "by_location": "/work/locations/{slug}"
  },
  "branding": { "…": "…" },
  "license_number": null,
  "cities_served": ["Marietta", "Roswell"],
  "public_face": { "name": "…", "title": "Owner", "bio": "…", "sameAs": [] },
  "booking_url": null,
  "cta_kind": "call",
  "cta_label": null
}

Using the path fields

Section titled “Using the path fields”
  • canonical_domain is the domain the pages are served on, without a trailing slash. It is null until the business connects a domain.
  • jobs_base_path (default /work) is where job pages live: a job’s URL is {canonical_domain}{jobs_base_path}/{job_slug}.
  • category_index_paths.by_service and .by_location are the service and town index pages. Replace {slug} with a job’s service_type or service_city.
  • service_path_pattern and location_path_pattern are the business’s own service and area pages on its main site, the targets of a job’s money_page_service_url and money_page_area_url.
  • Show the trade as industry_label ?? primary_vertical. industry_label is set only when primary_vertical is "other".
  • cta_kind: "book" only applies when booking_url is non-null; otherwise render the call button.

Headers

Section titled “Headers”

ETag, honoured by If-None-Match → 304. No Cache-Control on a normal response. See Caching.

Errors

Section titled “Errors”
Status error When
401 / 403 / 404 See Authentication.
410 business_closed The business’s account is closed. Permanent; stop serving its pages. Only the business’s own key sees this.
500 lookup_failed Temporary; retry.
SimplifyLocal