Register

Register User

This endpoint is used to register a new user.

Request Body

• username: (string, required) The username of the user.

• email: (string) The email address of the user.

• firstname: (string) The first name of the user.

• lastname: (string) The last name of the user.

• userType: (string) The type of user.

• remoteId: (string, optional) The third-party user's identifier.

• metadata: (json, optional) Additional information about the third-party user.

Response

Upon successful registration, the endpoint returns a JSON object with the following fields:

• createdAt: The date and time when the user was created.

• updatedAt: The date and time when the user was last updated.

• username: The username of the registered user.

• email: The email address of the registered user.

• firstname: The first name of the registered user.

• lastname: The last name of the registered user.

• userType: The type of the registered user.

• id: The unique identifier of the registered user.

• emailVerifiedAt: The date and time when the user's email was verified.

• lastAllotedDevice: The last device allotted to the user.

• deletedAt: The date and time when the user account was deleted.

• isSuperAdmin: Indicates if the user is a super admin.

• associatedGeoPointId: The ID of the associated geographical point.

• remoteId: (string, optional) The third-party user's identifier.

• metadata: (json, optional) Additional information about the third-party user.

Example Response

{
    "createdAt": "",
    "updatedAt": "",
    "username": "",
    "email": "",
    "firstname": "",
    "lastname": "",
    "userType": "",
    "id": "",
    "emailVerifiedAt": null,
    "lastAllotedDevice": null,
    "deletedAt": null,
    "isSuperAdmin": true,
    "associatedGeoPointId": null,
    "remoteId": null,
    "metadata": null
}