Get institute settings

Returns the institute-level configuration for the institute identified in the URL — branding, default behavior toggles, integration credentials, and similar values that other API calls look up at runtime.

Without keys, every setting on the institute is returned. With keys, only the matching settings are returned and their values are also evicted from the institute-settings cache, so the next read reflects any out-of-band update immediately. When keys is supplied and none of them exist on the institute, the call returns 404; without keys, an empty list is returned for an institute that has no settings yet.

Use this when you administer multiple institutes and need to fetch settings for a specific one. To read your own institute's settings, use GET /organisations/active/settings — same shape, current institute implied.

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

Expand an ID field to an object

string

Sort by a specific field

string

Specify a viewID to customize the result

string

Specify viewColumns to extend the result

string

Filter by institute settings keys

Headers
string
Defaults to Swagger
Responses
200

Successfully fetched institute settings.

400

The provided keys are invalid.

401

You do not have permission to view the specified institute settings.

404

The provided institute was not found.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!