Create an API token

POST

/api/v1/auth

Rotates and returns the caller’s default token. Intended for the browser extension and mobile app; public API consumers should create a token in Settings → API tokens instead.

Request Body^required

application/json

object

email

required

string format: email

password

required

string format: password

otp_attempt

string

Required when two-factor is enabled

Responses

200

A freshly rotated token secret

Response body

application/json

object

token

string

401

Missing, invalid or expired token

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request POST \
  --url https://app.responsehub.io/api/v1/auth \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "password": "example", "otp_attempt": "example" }'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/auth")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{ \"email\": \"hello@example.com\", \"password\": \"example\", \"otp_attempt\": \"example\" }"

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.responsehub.io/api/v1/auth', [
  'body' => '{ "email": "hello@example.com", "password": "example", "otp_attempt": "example" }',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/auth';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"email":"hello@example.com","password":"example","otp_attempt":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.responsehub.io/api/v1/auth"

  payload := strings.NewReader("{ \"email\": \"hello@example.com\", \"password\": \"example\", \"otp_attempt\": \"example\" }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Request body example

Example^generated

{
  "email": "hello@example.com",
  "password": "example",
  "otp_attempt": "example"
}

200example

Example^generated

{
  "token": "rh_1f3c…"
}

401example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

Create an API token

Request Bodyrequired

Responses

200

401

Request Body^required