Nudgescribe API Reference
APIs
API types
API types
  • Authentication
  • Content
  • Campaign
APIs
API types
API types
  • Authentication
  • Content
  • Campaign
  1. Authentication
  • Nudgescribe API
  • Authentication
    • Authentication
    • Authenticate
      POST
    • Re-Authenticate
      GET
  • Content
    • Customers
      • Customer Management
      • Upload and Validate Customer Data
      • Get pages
      • Get Customers
      • Delete Customers
    • Customer Groups
      • Customer Groups
      • Create Customer Group
      • Get Customer Groups
      • Update Customer Group
      • Delete Customer Group
    • Customer Profile Fields
      • Customer Profile Fields
      • Create a Custom Profile Field
      • Get Customer Profile Fields for a Workspace
      • Update Custom Fields
      • Delete Custom Fields
  • Campaigns
    • Campaign Messages Management
    • Get All Accounts Campaigns
      POST
    • Publish Messages to Secure Storage
      POST
    • Get Campaign Messages Pages
      POST
    • Retrieve Published Messages
      POST
APIs
API types
API types
  • Authentication
  • Content
  • Campaign
APIs
API types
API types
  • Authentication
  • Content
  • Campaign
  1. Authentication

Authenticate

POST
https://client-api.nudgescribe.com/v1/auth
AuthenticationAuthUserClientAccess TokenRefresh Token
Primary authentication endpoint for client applications and third-party integrations requiring programmatic access to the NudgeScribe platform.
Enables secure authentication for external clients using API credentials, providing JWT tokens for subsequent API calls.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Bad Request
🔴500Server Error
🟠403Unauthorised
🟠401Missing Fields
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://client-api.nudgescribe.com/v1/auth' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "Orval_Corwin47@yahoo.com",
    "password": "hkbPbkns6cGq0nH"
}'
Response Response Example
200 - Example 1
{
    "code": 0,
    "message": "string",
    "token": "string",
    "refresh_token": "string"
}
Modified at 2026-01-29 13:09:11
Previous
Authentication
Next
Re-Authenticate
Built with