Skip to content
TotalView API

Self-service registration (free plan)

POST
/api/v1/auth/register
 
curl --request POST \
  --url https://api.totalview.energy/api/v1/auth/register \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "password": "example", "full_name": "example", "company_name": "example" }'

Create a new free-plan customer and user in one transaction. Issues a JWT immediately.

Request Body required

Section titled “Request Body required ”
Media type application/json
RegisterRequest
object
email
required
Email
string
password
required
Password
string
full_name
Any of:
string
company_name
Any of:
string
Example generated
{
  "email": "example",
  "password": "example",
  "full_name": "example",
  "company_name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Example generated
example

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}