Get Settings
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
The GUID of the person (participant). Provide this OR business_id, not both.
The GUID of the employer (business entity). Provide this OR person_id, not both.
The GUID of the offering (optional).
The name of the setting (optional).
Response
Successfully retrieved settings.
Response Attributes
Gets or sets the collection of settings that matched the request.
Show child attributes
Gets or sets the GUID of the admin the settings were requested for.
Gets or sets the GUID of the employer the settings were filtered by.
Invalid request. Check query parameters.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized. Authentication failed.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Forbidden. Identity could not be verified or caller does not have access to this resource.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Not Found.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal server error.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: