Account

User.Basic

• User.Basic should be loaded after login and cached by the UI.
• It returns user data, organization data, permissions, folders, statuses, tags, tabs/entries settings, file folders, field settings, custom fields, team members, and other configuration used to build forms.
• Use these settings to decide which buttons, fields, folders, statuses, and filters the user can see.

Folders, Statuses, Tags

• Folder routes manage customer folders in account settings and in user visibility settings.
• Statuses.* routes manage all_status buckets (ticket, internal_status, folder customer_status, sources, etc.).
• CustomerStatuses.* routes manage the settings Customer Statuses modal (new_index_status / cust_dynamic_name / custom_customer_status).
• Folder internal statuses: Statuses.List with type=internal_status and folder_id (from User.Basic data.folders). Use data[].id when assigning an internal status.
• User.Basic also returns all_status rows (data.statuses.internal) for UI bootstrap; CustomerStatuses.List matches the Customer Statuses settings screen.
• Tag routes manage account tags that can be assigned to customers and other records.

Login

• Login accepts the allowed identifier fields documented on the Login route and returns a bearer token.
• Save the bearer token in the UI and send it on every protected route with Authorization: Bearer YOUR TOKEN.
• If OTP is required, complete the OTP flow before calling protected routes.

Common Flow

• Call Login and save the bearer token.
• Call User.Basic and store permissions/settings.
• Render menus, filters, folders, statuses, tags, fields, and team options from User.Basic.
• Use CustomerStatuses.List for the Customer Statuses settings screen. Use Statuses.List for all_status buckets (type=ticket, internal_status + folder_id, etc.).
• Use Account routes only for settings actions the user is allowed to perform.

Routes In This Category