The User API

The SimplifyAccess User API allows authenticated applications to access account information, retrieve controllers, read widget settings, and update selected widget configurations.

All API communication uses JSON and HTTPS. Access is secured using Bearer Authentication and requires a valid API token generated from your SimplifyAccess account.

Base URL

All endpoints are available under the following base URL:

https://admin.simplify-access.com/api/v1  

Authentication

All requests must include a valid API token in the Authorization header.

Example:

Authorization: Bearer YOUR_API_TOKENAccept: application/json  

Requests without a valid token will be rejected.

Available Endpoints

GET /me

Returns information about the authenticated user.

Example request:

curl -X GET \
	https://admin.simplify-access.com/api/v1/me \
	-H "Authorization: Bearer YOUR_API_TOKEN" \
	-H "Accept: application/json"  

Example response:

{ 
	"data": { 
		"id": 123, 
		"name": "John Doe", 
		"email": "john@example.com", 
		"language": "en", 
	}
}  

GET /controllers

Returns all controllers assigned to the authenticated user.

Example request:

curl -X GET \
	https://admin.simplify-access.com/api/v1/controllers \
	-H "Authorization: Bearer YOUR_API_TOKEN" \
	-H "Accept: application/json"  

Example response:

{ 
	"data": [ 
		{ 
			"id": 1, 
			"client_id": "UUID", 
			"domain_name": "example.com", 
			"init_domain": "example.com", 
			"created_at": "2026-06-01T10:00:00Z", 
			"updated_at": "2026-06-05T12:00:00Z" 
		} 
	]
}  

GET /controllers/{clientId}/settings

Returns the settings of a specific controller.

Example request:

curl -X GET \
	https://admin.simplify-access.com/api/v1/controllers/abc123/settings \
	-H "Authorization: Bearer YOUR_API_TOKEN" \
	-H "Accept: application/json"  

PATCH /controllers/{clientId}/settings

Updates selected settings of a specific controller.

Only submitted settings are changed. All other settings remain unchanged.

Example request:

curl -X PATCH \
	https://admin.simplify-access.com/api/v1/controllers/abc123/settings \
	-H "Authorization: Bearer YOUR_API_TOKEN" \
	-H "Accept: application/json" \
	-H "Content-Type: application/json" \
	-d '{ "language": "en", "setting_read_aloud": true}'  

Readable Settings

The following settings can be retrieved through the API.

Interface Settings

Accessibility Settings

Content Selection

Widget Options

Writable Settings

The following settings can currently be modified through the User API.

Certain internal settings, subscription-related settings, entitlement settings, plugin configurations, and domain ownership settings cannot be modified through the User API.

Error Responses

Missing Bearer Token

{ "message": "Missing bearer token."}  

Invalid or Revoked Token

{ "message": "Invalid or revoked bearer token."}  

Validation Error

{ "message": "The given data was invalid."}  

Security Recommendations

• Always use HTTPS.
• Store API tokens securely.
• Never expose API tokens in frontend applications.
• Revoke tokens that are no longer needed.
• Rotate API tokens periodically as part of your security procedures.

Typical Integration Flow

1. Generate an API token in your SimplifyAccess account.
2. Authenticate using Bearer Authentication.
3. Retrieve user information using /me.
4. Retrieve available controllers using /controllers.
5. Retrieve settings using /controllers/{clientId}/settings.
6. Update allowed settings using /controllers/{clientId}/settings.

This workflow allows external applications to manage SimplifyAccess widget settings while maintaining account security and access control.