Verify token

Overview

Use this endpoint to confirm that an access token is valid and retrieve the session context needed to rehydrate a session. That context includes the authenticated user, company, theme and white-label settings, and—for account users—plan context. The response echoes the supplied bearer token.

Call this endpoint before making requests so you can refresh an expired token before it interrupts a workflow.

Prerequisites

• Send a bearer token in the Authorization header.

Base URL

Endpoint

GET /api/v1/verify-token

Authentication

Send the access token in the Authorization: Bearer <access_token> header.

Rate limit

This endpoint has no rate limit.

How it works

• A 200 response returns the user, company, and session context while the token is valid.
• A 401 Unauthenticated response indicates that the token has expired or been revoked. Refresh the token or sign in again.

Response

200 Success

{
  "data": {
    "token": "<bearer-token>",
    "user": {
      "id": 8,
      "email": "[email protected]"
    },
    "company": {
      "id": 9,
      "name": "HiPages",
      "bundle_id": 1,
      "companyindustry_id": 7,
      "company_industry": { "id": 7, "name": "Trades & Services" },
      "is_sub_partner": 0
    },
    "theme_options": null,
    "white_label": {},
    "plan": null
  }
}

401 Unauthenticated

{
  "message": "Unauthenticated."
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/verify-token" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'