Skip to main content
POST
Register new user

Overview

Create a new user account and automatically set up their organization. After registration, a verification email is sent, and the user is automatically logged in with an authentication token.

Request Body

string
required
User’s full name. Also used to generate a default organization name.Example: "John Doe"
string
required
User’s email address. Must be unique in the system.Format: Valid email addressExample: "john.doe@example.com"
string
required
User’s password. Should be strong and secure.Example: "SecurePassword123!"
string
required
Password confirmation. Must match the password field.Example: "SecurePassword123!"
object
Optional custom organization/team details. If not provided, defaults to “[Name]‘s Organization”.
string
User’s timezone.Example: "America/New_York"
string
User’s phone number.Example: "+1-555-123-4567"

Response

The response is identical to the login endpoint, containing user details and authentication token.
integer
User’s unique identifier.
string
User’s full name.
string
User’s email address.
string
Automatically generated unique username.
string
URL to user’s profile picture (default avatar).
integer
ID of the newly created organization/team.
string
Authentication token for API requests. Use this in the Authorization: Bearer {token} header.
string
User’s role (always "owner" for new registrations).
string
Admin status (always "yes" for new registrations).
integer
Number of contacts (0 for new users).
integer
Onboarding flag: Whether the first project has been added (0 for new users).
integer
Onboarding flag: Whether the first task has been added (0 for new users).
integer
Onboarding flag: Whether the first team member has been invited (0 for new users).
string
App identifier (set to “tracker”).
integer
Maximum speed limit setting (80).
string
Email verification timestamp (null until verified).
string
Timestamp when the user account was created.
string
Timestamp when the user account was last updated.

Example Request - Basic Registration

Body

application/json
name
string
required

User's full name

Example:

"John Doe"

email
string<email>
required

User's email address (must be unique)

Example:

"john.doe@example.com"

password
string<password>
required

User's password

Example:

"SecurePassword123!"

c_password
string<password>
required

Password confirmation (must match password)

Example:

"SecurePassword123!"

team
object

Optional custom organization details

timezone
string

User's timezone

Example:

"America/New_York"

phone
string

User's phone number

Example:

"+1-555-123-4567"

Response

Registration successful

id
integer
Example:

1

name
string
Example:

"John Doe"

email
string<email>
Example:

"john.doe@example.com"

profile_photo_url
string<uri>
Example:

"https://s3.amazonaws.com/bucket/profiles/user-1.jpg"

current_team_id
integer
Example:

5

token
string

Bearer token for API authentication

Example:

"1|Ab3dEfGh1Jk2Lm3No4Pq5Rs6Tt7Uv8Wx9Yz0"

role
enum<string>
Available options:
owner,
manager,
member,
client
Example:

"owner"

isAdmin
enum<string>
Available options:
yes,
no
Example:

"yes"

contact_count
integer
Example:

15

is_first_project_added
enum<integer>

0 = not added, 1 = added

Available options:
0,
1
Example:

1

is_first_task_added
enum<integer>

0 = not added, 1 = added

Available options:
0,
1
Example:

1

is_first_member_invited
enum<integer>

0 = not invited, 1 = invited

Available options:
0,
1
Example:

1

timezone
string
Example:

"America/New_York"

two_factor_confirmed_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>