Customer Portal

How To Use This Category

• Start with the List route when building a table or screen list.
• Use Count with the same filters when the UI needs total rows for paging.
• Use Get/View routes to open a single record.
• Use Add/Create, Edit/Update, Status/Done, and Delete/Remove routes for actions when they exist.

Permissions

• Every route uses the logged-in user permissions and account settings.
• Do not show actions in the UI unless the user has permission from User.Basic or the route response allows it.

Data Rules

• Keep ids returned from list/add calls and reuse them for later actions.
• Send date/time values as UTC Y-m-d H:i:s.
• For list routes, never request more than 25 rows per call.

Common Flow

• Login and save the bearer token.
• Call User.Basic and store permissions/settings.
• Open the category routes below for exact required and optional parameters.
• Use the route response examples to build success, empty, and error states.

Routes In This Category