Register creates the first admin user (becomes instance owner) - Self-hosted only

POST/v1/auth/register

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Request Body (JSON)

Request Body

Property	Type	Required
`email`	`string`	No
`password`	`string`	No
`name`	`string`	No

Responses

200 Registration result with session

Property	Type	Description
`success`	`boolean`
`user`	`object`
`sessionToken`	`string`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/auth/register" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","password":"string","name":"string"}'

const response = await fetch("http://localhost:8089/v1/auth/register", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "email": "string",
  "password": "string",
  "name": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/auth/register",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "email": "string",
  "password": "string",
  "name": "string"
},
)
data = response.json()

Response

{
  "success": true,
  "user": {
    "user": {
      "id": "string",
      "email": "string",
      "name": "string",
      "avatarUrl": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    },
    "organizations": [
      {
        "id": "string",
        "slug": "string",
        "name": "string",
        "role": "ORGANIZATION_ROLE_UNSPECIFIED"
      }
    ]
  },
  "sessionToken": "string"
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}