Skip to main content
GET
/
client
/
settings
Get my client settings
curl --request GET \
  --url http://localhost:8080/api/v1/client/settings \
  --header 'Authorization: <api-key>'
{
  "data": {
    "afternoon_send_hour": 123,
    "afternoon_send_minute": 123,
    "ai_advisor_enabled": true,
    "auto_approve_enabled": true,
    "brand_logo_url": "<string>",
    "brand_name": "<string>",
    "brand_primary_color": "<string>",
    "brand_secondary_color": "<string>",
    "client": {
      "api_key": "<string>",
      "api_key_enabled": true,
      "avatar_file": {
        "category": "<unknown>",
        "created_at": "<string>",
        "deleted_at": {
          "time": "<string>",
          "valid": true
        },
        "file_size": 123,
        "id": 123,
        "mime_type": "<string>",
        "original_filename": "<string>",
        "storage_path": "<string>",
        "unique_id": "<string>",
        "updated_at": "<string>",
        "url": "<string>",
        "user_id": 123
      },
      "avatar_file_id": 123,
      "avatar_url": "<string>",
      "city": "<string>",
      "client_id": "<string>",
      "country": "<string>",
      "created_at": "<string>",
      "current_user_count": 123,
      "deleted_at": {
        "time": "<string>",
        "valid": true
      },
      "email": "<string>",
      "email_verified_at": "<string>",
      "first_name": "<string>",
      "id": 123,
      "is_email_verified": true,
      "last_name": "<string>",
      "monthly_email_quota": 123,
      "monthly_emails_sent": 123,
      "phone": "<string>",
      "quota_reset_at": "<string>",
      "roles": [
        {
          "created_at": "<string>",
          "deleted_at": {
            "time": "<string>",
            "valid": true
          },
          "id": 123,
          "updated_at": "<string>",
          "user_id": 123
        }
      ],
      "state": "<string>",
      "status": "<unknown>",
      "street_address": "<string>",
      "subscription_billing_period": "<string>",
      "subscription_ends_at": "<string>",
      "subscription_plan": {
        "created_at": "<string>",
        "deleted_at": {
          "time": "<string>",
          "valid": true
        },
        "description": "<string>",
        "display_order": 123,
        "has_advanced_ai_logic": true,
        "has_ai_advisor": true,
        "has_ai_journey_mapping": true,
        "has_core_playbooks": true,
        "has_health_monitor": true,
        "has_one_click_fixes": true,
        "has_priority_growth_support": true,
        "has_priority_processing": true,
        "has_smart_3_event_setup": true,
        "has_unlimited_flows": true,
        "id": 123,
        "is_active": true,
        "max_emails_per_day": 123,
        "max_emails_per_month": 123,
        "max_users": 123,
        "max_workflows": 123,
        "name": "<string>",
        "price_annually_eur": 123,
        "price_monthly_eur": 123,
        "updated_at": "<string>"
      },
      "subscription_plan_id": 123,
      "subscription_status": "<string>",
      "subscription_tier": "<string>",
      "updated_at": "<string>",
      "website": "<string>",
      "zip_code": "<string>"
    },
    "client_id": 123,
    "company_address": "<string>",
    "company_name": "<string>",
    "created_at": "<string>",
    "custom_email_quota_per_day": 123,
    "custom_email_quota_per_month": 123,
    "custom_max_workflows": 123,
    "deleted_at": {
      "time": "<string>",
      "valid": true
    },
    "email_from_address": "<string>",
    "email_from_name": "<string>",
    "email_reply_to": "<string>",
    "email_signature": "<string>",
    "enable_critical_bypass": true,
    "enabled_workflows": [
      123
    ],
    "id": 123,
    "max_emails_per_day": 123,
    "morning_send_hour": 123,
    "morning_send_minute": 123,
    "preferences": [
      123
    ],
    "queue_timeout_days": 123,
    "quiet_hour_end": 123,
    "quiet_hour_start": 123,
    "send_window_allowed_days": "<string>",
    "send_window_enabled": true,
    "send_window_end_hour": 123,
    "send_window_start_hour": 123,
    "timezone": "<string>",
    "updated_at": "<string>"
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}

Authorizations

Authorization
string
header
required

JWT Bearer token or raw API key via Authorization header

Response

OK

data
object
errors
object[]
message
string
Example:

"Operation successful"

meta
object
success
boolean
Example:

true