Endpoint topic

Callable endpoints

Each class contains callable methods that will call a method on the server side. The classes are accessible via the Serverpod client you have created in your Flutter app. The name of the module is defined in your config/generator.yaml file in the server project.

modules:
  <module_name>:
    nickname: <nickname>

The name "EndpointClass" where Class is your class name will have the "Endpoint" part stripped when the client is code generated. When accessing you can simply use the endpoint name in lowercase.

Example usage:

// Authenticate with email.
client.modules.auth.email.authenticate(email, password)

// Generic format.
client.modules.<nickname>.<endpoint>.<method>(...)

Please see the full official documentation here

Classes

EndpointLegacyAdmin

Endpoint for legacy admin operations. Requires admin scope.

EndpointLegacyEmail

Proxy endpoint that handles legacy email authentication requests from old clients (pre-migration). Delegates to the new auth system internally.

EndpointLegacyStatus

Proxy endpoint for legacy session status operations (sign-in check, sign-out, user info retrieval).

EndpointLegacyUser

Proxy endpoint for legacy user profile operations (image, name changes).

EndpointSessionMigration

Endpoint to convert legacy sessions.