---
title: "Signup"
method: POST
path: "/signup"
tags: ["authentication"]
---

# Signup

`POST /signup`

## Request

- Base URL: `https://localhost:8080/api/v9`
- URL: `https://localhost:8080/api/v9/signup`
- Auth: none declared
- TypeScript: <https://skmtc.dev/toggl/apis/toggl-api/docs/signup/post.ts> (a function with typed inputs; its response is checked against the schema)

Sign up as a new user.

## Request body

- MePostUser
  - `country_id` integer: User's country ID, if not provided will be United States
  - `created_with` string: Should describe the application/service that is using the API
  - `email` string, email, required: Email for new user account
  - `full_name` string: User's full name, if not provided will be derived from the email address
  - `invitation_code` string: Optional, used when creating account through an invitation
  - `password` string, required: Password for new user account
  - `timezone` string: User's timezone, if not provided will be UTC
  - `tos_accepted` boolean, required: Whether the Terms of Service have been accepted
  - `workspace` MePostInitialWorkspace
    - `initial_pricing_plan` integer: Plan ID for the new workspace
    - `name` string: Workspace name, if not provided it will be based on the user's full name

## Response `200`

Successful operation.

- ModelsTogglUser
  - `api_token` string: will be omitted if empty
  - `at` string, date-time
  - `beginning_of_week` integer
  - `country_id` integer
  - `created_at` string, date-time
  - `default_workspace_id` integer
  - `email` string, email
  - `fullname` string
  - `has_password` boolean
  - `id` integer
  - `image_url` string
  - `openid_email` string, email
  - `openid_enabled` boolean
  - `options` ModelsOptions
  - `timezone` string
  - `updated_at` string, date-time

## Other responses

- `400`: Possible error messages: * Account has pending invite * email is required * initial workspace pricing plan must be specified * Invalid country ID * Invalid e-mail * invalid e-mail: domain not permitted * Invalid invitation code * Invalid pricing plan specified * invalid timezone value * Must accept terms of service * password is missing * password should be at least 6 characters * provider is missing * Sorry, but this invitation seems either accepted or canceled * user with this email already exists * workspace name must contain non-space characters
- `408`: connection reset by peer
- `500`: Internal Server Error

---

[API](https://skmtc.dev/toggl/apis/toggl-api.md) - [All operations](https://skmtc.dev/toggl/apis/toggl-api/llms.txt) - [OpenAPI document](https://skmtc.dev/toggl/apis/toggl-api/revisions/3085aee16990?raw)