Skip to main content

Workspace Owner Signup (v1)

Method & Path​

POST /api/v1/signup

Actual backend path: /v1/signup

note

This public signup path is separate from /v1/workspace/:workspaceId so registration cannot collide with authenticated workspace routes. The legacy POST /v1/workspace/ create endpoint is unchanged.

Description​

Creates a new workspace and Workspace Owner login. Returns a workspace access token for the new owner.

Authentication​

None: Public. Unauthenticated visitor becomes a Workspace Owner.

Persona access:

  • Visitor (public): yes
  • Workspace Owner: created by this call
  • Staff: no
  • Admin: no
  • Customer: no

Headers​

HeaderTypeRequiredDescription
Content-TypestringYesapplication/json

Request Body​

{
"email": "owner@example.com",
"password": "SecurePass12",
"phone": "+972595590939",
"planId": "507f1f77bcf86cd799439011",
"businessCategorySlug": "stores",
"marketingOptIn": true
}
ParameterTypeRequiredDescription
emailstringYesOwner email (unique)
passwordstringYesAt least 8 characters and one number
phonestringYesE.164 phone number, e.g. +972595590939
planIdstringYesActive plan id
businessCategorySlugstringYesActive business category slug
marketingOptInbooleanNoDefaults to false
namestringNoWorkspace name
sloganstringNoWorkspace slogan
workingHoursobjectNoOptional 7-day schedule

Response 201 Created​

{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"workspace": {
"id": "507f1f77bcf86cd799439011",
"name": null,
"slogan": null,
"email": "owner@example.com",
"phone": "+972595590939",
"phoneVerified": false,
"requirePhoneVerification": true,
"planId": "507f1f77bcf86cd799439011",
"businessCategorySlug": "stores",
"marketingOptIn": true,
"discountPercentage": null
}
}

Common Errors​

  • 409 Conflict: Email (or another unique field) already exists
  • 422 Unprocessable Entity: Invalid email, password, phone, plan, or category
  • 400 Bad Request: Malformed JSON or invalid identifier
  • 500 Internal Server Error: Unexpected server error (response message includes the underlying cause)