Version: 1.0.0

User API - Introduction

Manage user accounts, settings, preferences, notifications, and group configurations.

Users

The User endpoints let administrators create, retrieve, search, and update user accounts. Regular users can update their own profile via the Update Self endpoint.

• Roles: Users are assigned roles (Admin, Manager, Creator, User) that determine their permissions across the platform
• Notifications: Retrieve system notifications for the authenticated user

User Settings

The Settings endpoints manage account-level and group-level configuration:

• Account Settings — retrieve the authenticated user's account settings (storage, processing, addon configuration)
• Group Settings — view and update settings for user groups
• User Preferences — per-user preferences such as UI settings and defaults
• Addon Settings — enable or disable AI/ML addons (face recognition, background removal, etc.)
• Watermark — upload and configure watermark images for image and video processing

Admin User Activation

Newly signed-up Admin users will receive an activation email that takes them through the activation process. Once an admin user is signed-up, they can login to create more users within their user group using the User API.

User Profile JSON Format

All User Profile API responses use the following JSON format:

{
  "id": "USER_ID",
  "access_id": "ACCESS_ID",
  "apikey": "API_KEY",
  "email": "user@example.org",
  "first_name": "FIRST NAME",
  "last_name": "LAST NAME",
  "enabled": true,
  "invite_status": "REGISTERED",
  "role_id": "ROLE_ID",
  "group_id": "GROUP_ID",
  "locale": "en_US",
  "permissions": [],
  "role_name": "USER",
  "uploadKey": "UPLOADKEY",
  "group_asset_access": true,
  "addons": ["ADDON_ID"]
}

Key	Value	Description
id	number	User id
access_id	string	Access id, used for signing requests for CDN APIs
apikey	string	API Key. Used for making API requests. Do not share.
email	string	User email. Must be a valid and accessible email.
first_name	string	First name of user
last_name	string	Last name of user
enabled	boolean	true if user is enabled. false if disabled.
invite_status	string	REQUESTED = Login not activated yet. REGISTERED = activated and ready for use.
role_id	number	Role id (see Users & Roles section for details)
group_id	string	User group ID
locale	string	Default User locale
permissions	List	List of Permissions. Permissions are string tokens that define what actions a user is allowed to perform. Permissions are determined by User Role.
role_name	string	Role name (built-in)
uploadKey	string	Upload Key for use in FileSpin Picker for file uploads. Note that a USER role will not be allowed to upload files even if they have a valid Upload Key.
group_asset_access	boolean	If true allows this user access to assets created by all users within the user group. If false, they can only see their own assets.
addons	List	Addons available for the User. Note that even if an addon is available, they may not have permission to use it or may not have it enabled.

Authentication

HTTP: Bearer Auth

JWT token obtained from POST /api/v1/login

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT

API Key: ApiKeyAuth

API key for programmatic access

Security Scheme Type:	apiKey
Header parameter name:	X-FileSpin-Api-Key