Nudgescribe API Reference
APIs
API types
  • Authentication
  • Content
  • Campaign
APIs
API types
  • Authentication
  • Content
  • Campaign
  1. Customers
  • Nudgescribe API
  • Authentication
    • Authentication
    • Authenticate
      POST
    • Re-Authenticate
      GET
  • Content
    • Customers
      • Customer Management
      • Upload and Validate Customer Data
        POST
      • Get pages
        POST
      • Get Customers
        POST
      • Update Customers
        PATCH
      • Delete Customers
        DELETE
    • 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
    • Campaigns and Campaign Messages
    • Get All Accounts Campaigns
      POST
    • Publish Messages to Secure Storage
      POST
    • Retrieve Published Messages
      POST
    • Get Campaign Messages Pages
      POST
  1. Customers

Get Customers

POST
https://client-api.dev.nudgescribe.com/v1/customer
ContentCustomersCustomer ManagementGetRetrieveCustomer
Retrieves customer records from a specific customer group with pagination support, returning encrypted profile data that can be decrypted as needed.
Enables your application to fetch and display customer data with proper pagination and security controls.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Bad Request
🟠401Unauthorised
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://client-api.dev.nudgescribe.com/v1/customer' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "customer_group_id": "your-customer-group-id",
  "page": 10
}'
Response Response Example
200 - Example 1
[
    {
        "customer_id": "uuid",
        "customer_group_id": "uuid",
        "account_id": "uuid",
        "extended_profile": {
            "email": "encrypted-string",
            "first_name": "John",
            "last_name": "Doe",
            "customer_type": "VIP"
        },
        "created_at": "2023-08-20T10:00:00Z",
        "updated_at": "2023-08-21T12:00:00Z"
    }
]
Modified at 2025-10-30 06:18:59
Previous
Get pages
Next
Update Customers
Built with