Get Customer Profile Fields for a Workspace

POST

https://client-api.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

🟠403Unauthorised

🟠401Missing Fields

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://client-api.nudgescribe.com/v1/cpf' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workspace_id": "your-workspace-uuid"
}'

Response Example

200 - Example 1

[
    {
        "field_id": "string",
        "workspace_id": "string",
        "field_key": "string",
        "display_name": "string",
        "field_type": "string",
        "field_format": "string",
        "validation_regex": "string",
        "is_required": true,
        "pii": true,
        "is_default": true,
        "order_pos": 0,
        "created_at": "string",
        "updated_at": "string",
        "created_by": "string",
        "updated_by": "string",
        "enum_value": [
            {}
        ]
    }
]

Modified at 2026-01-29 13:09:11

Create a Custom Profile Field

Update Custom Fields