MImindbodyonline
Rest

Gets settings from General Setup and Options page.

get/Settings

Request

Query parameters

request.categoriesstring[]

Categories of the site settings to retrieve. If null, retrieve all settings. Category possible values:

  • Client
  • Communication
  • General: General site settings.
  • Location: Site location settings.
  • Scheduling: Site scheduling settings, i.e. class and enrollments settings, etc.
request.locationIdinteger

Location identifier if location settings are specified. Will be ignored if location category is not specified.

request.dependentIdstring

User identifier for an optional dependent account. Retained for backwards compatibility only - the settings returned are site-scoped and identical for every caller, so this value is ignored.

Headers

SiteIdinteger required

Site ID

Response

OK

Categorystring

The setting category (ie. "Communication")

Namestring

Name of site setting

Valuestring

Value of the site setting

ValueTypestring

Data type of the setting value (ie. "string", "bool", etc.)

Changes

No recorded changes to this operation across all 3 revisions of this API.