Authentication

Refresh token

Use a refresh token to obtain new access and refresh tokens

post/nhsapi/v1/Auth/refresh

Request

  • Base URL: https://www.example.com
  • URL: https://www.example.com/nhsapi/v1/Auth/refresh
  • Auth: none declared

Request body

refresh_tokenstring required

The refresh token obtained from login

Example request

{
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response

token refreshed successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "account": {
      "id": 1,
      "email": "test@example.com",
      "name": "Test API Account",
      "organisation_id": 1,
      "permissions": {
        "worker_basic_read": true,
        "shift_basic_read": true,
        "shift_advanced_read": true,
        "create_shifts": true
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.