Show Business Settings

Overview

Returns the full settings object for the business, including profile fields, client-facing visibility flags, branding, and the server-geocoded structured_address.

Available for Staff & Directory tokens — a Staff token of a staff member belonging to the business, or a Directory token of the owning directory. Directory tokens MUST send the business in the X-On-Behalf-Of header (a Directory token without it is rejected with 403).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The business UID — the public identifier of the business (e.g., "fyclhomrzdspdyk6").

Headers
string

The business UID to act on behalf of. Required when authenticating with a Directory token; not needed for a Staff token (e.g., "fyclhomrzdspdyk6").

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json