Who am I

GET

/v1/auth/profile

curl --request GET \
  --url https://shareout.site/v1/auth/profile \
  --header 'Authorization: Bearer <token>'

• Production

The account this API key belongs to. Call it first to check the key works; a 401 here means reconnect (see the error hint).

Authorizations

• bearerAuth

Responses

200

The signed-in account

Media typeapplication/json

object

id

string

email

string | null

username

string | null

name

string | null

metadata

object

created_at

string

Example^generated

{
  "id": "example",
  "email": "example",
  "username": "example",
  "name": "example",
  "metadata": {},
  "created_at": "example"
}

401

Authentication required

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}