Nudgescribe API Reference
APIs
API types
  • Authentication
  • Content
  • Campaign
APIs
API types
  • Authentication
  • Content
  • Campaign
  1. Customer Profile Fields
  • Nudgescribe API
  • Authentication
    • Authentication
    • Authenticate
      POST
    • Re-Authenticate
      GET
  • Content
    • Customers
      • Customer Management
      • Upload and Validate Customer Data
      • Get pages
      • Get Customers
      • Update 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
        PUT
      • Get Customer Profile Fields for a Workspace
        POST
      • Update Custom Fields
        PATCH
      • Delete Custom Fields
        DELETE
  • 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. Customer Profile Fields

Get Customer Profile Fields for a Workspace

POST
https://client-api.dev.nudgescribe.com/v1/cpf
ContentCustomerProfleCustomer Profile FieldsCPFGet
Retrieves all custom fields configured for your workspace, including their definitions, validation rules, and available options for enum fields.
Allows your application to dynamically understand the customer data schema and build appropriate user interfaces for data collection and display.

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
🟠401Invalid Workspace
🟠403Auth Error
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://client-api.dev.nudgescribe.com/v1/cpf' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_id": "your-workspace-uuid"
  }'
Response Response Example
200 - Example 1
[
    {
        "field_id": "7e483dbd-b70c-40fc-99b4-24a3c967f876",
        "workspace_id": "8db025ae-7506-4b9e-a78f-1c1ebbb7ce48",
        "field_key": "customer_type",
        "display_name": "Customer Type",
        "field_type": "Enum",
        "field_format": "[\\\"VIP\\\",\\\"Regular\\\",\\\"Prospect\\\"]",
        "validation_regex": "null",
        "is_required": false,
        "pii": false,
        "is_default": false,
        "order_pos": 1,
        "created_at": "2025-09-09T08:29:29.083Z",
        "updated_at": "2025-09-09T08:29:29.084Z",
        "enum_values": [
            {
                "enum_value_id": "enum-uuid-2",
                "field_id": "e2931f69-47a2-4497-93b9-fea10414e89d",
                "enum_value": "Regular",
                "created_at": "2025-09-09T08:29:29.085Z",
                "updated_at": "2025-09-09T08:29:29.085Z"
            }
        ]
    }
]
Modified at 2025-09-11 13:08:30
Previous
Create a Custom Profile Field
Next
Update Custom Fields
Built with