Users

User management and authentication within the application. Provides endpoints to get the current authenticated user's profile, verify email addresses using verification keys from email links (with token expiration handling), and resend verification emails to authenticated users. Also includes tenant-scoped user management (CRUD operations) accessed via /tenants/{tenant}/users for managing users within specific tenants.

OpenAPI Spec

Guides Operations Schemas

GET Get current authenticated user
Returns the profile information of the currently authenticated user
/users/me
PUT Verify user's email address
Verifies a user's email address using the verification key from the email link. Returns 200 if email is successfully verified (idempotent - also retur...
/users/email-verification
POST Resend email verification link
Resends a verification email to the authenticated user's email address.
/users/email-verifications
GET List TenantUsers
Lists all TenantUsers for the given tenant. Requires: ViewAll on Users.
/tenants/{tenant}/users
POST Create TenantUser
Creates a new TenantUser for the specified tenant. An hourly or cost rate seeds the user's first rate entry; setting a cost rate requires the Cost Rat...
/tenants/{tenant}/users
GET Get TenantUser
Gets a TenantUser for the specified tenant. Requires: ViewAll on Users.
/tenants/{tenant}/users/{code}
PUT Update TenantUser
Updates a TenantUser for the specified tenant. Requires: Update on Users.
/tenants/{tenant}/users/{code}
DELETE Delete TenantUser
Deletes a TenantUser for the specified tenant. Requires: Delete on Users.
/tenants/{tenant}/users/{code}
PATCH Patch User
Applies a partial update to a user. Currently patches the time tracking fields: the working pattern (always applied — null clears it so the practice d...
/tenants/{tenant}/users/{code}
GET List User Rates
Lists the user's date-effective rate entries: the current entry first, then history by start date descending. Cost rates are null without the Cost Rat...
/tenants/{tenant}/users/{userCode}/rates
POST Change User Rate
Changes the user's current rates. With preserveHistory the current entry is closed the day before effectiveFrom and a new current entry begins; withou...
/tenants/{tenant}/users/{userCode}/rates
PUT Update User Rate
Full replacement of one rate entry — for correcting a historical entry's rates or dates. The edited entry must not overlap the user's other entries, a...
/tenants/{tenant}/users/{userCode}/rates/{rateCode}
DELETE Delete User Rate
Deletes one rate entry. Deleting the current entry leaves the user with no rate of their own, so the practice default applies to newly logged time unt...
/tenants/{tenant}/users/{userCode}/rates/{rateCode}
GET List Team Member Work Type Rates
Lists every team member's current rate for each task category or service they have one for, with the team member's code, ordered by type of work. Prac...
/tenants/{tenant}/work-type-rates/team-members
GET List User Work Type Rates
Lists the team member's rates by task category or service, grouped by type of work: each one's current entry first, then history by start date descend...
/tenants/{tenant}/users/{userCode}/work-type-rates
POST Change User Work Type Rate
Sets the team member's current rate for a task category or a service. With preserveHistory the current entry is closed the day before effectiveFrom an...
/tenants/{tenant}/users/{userCode}/work-type-rates
DELETE Delete User Work Type Rate
Deletes one rate entry. Deleting the current entry leaves that type of work with no rate of its own, so the next rule down applies to newly logged tim...
/tenants/{tenant}/users/{userCode}/work-type-rates/{rateCode}