Get Workspace Settings

GET

https://api.plusvibe.ai/api/v1/workspace-settings/

Returns the workspace-level settings in four groups: blocklist (where the blocklist is enforced + optional Google Sheet sync), domain_daily_cap (workspace-wide per-domain daily lead cap), ai_lead_labeling (labels the AI may auto-apply) and auto_follow_up (automatic follow-ups for quiet conversations).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200OK

application/json

Current settings

Bodyapplication/json

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.plusvibe.ai/api/v1/workspace-settings/?workspace_id=undefined' \
--header 'x-api-key: <api-key>'

Response Example

200 - Success Example

{
    "blocklist": {
        "apply_on": [
            "AUTO_FOLLOW_UP",
            "MANUAL_REPLY"
        ],
        "gsheet_url": "https://docs.google.com/spreadsheets/d/1AbCdEfG/edit#gid=0",
        "gsheet_sync_error": null
    },
    "domain_daily_cap": {
        "is_enabled": "yes",
        "max_leads_per_day": 3
    },
    "ai_lead_labeling": {
        "labels": [
            "INTERESTED",
            "HOT_LEAD"
        ]
    },
    "auto_follow_up": {
        "is_enabled": "yes",
        "wait_days": 3,
        "labels": [
            "INTERESTED",
            "UNLABELLED"
        ],
        "steps": [
            {
                "body": "<p>Hi {{first_name}}, just floating this back up.</p>",
                "wait_days": 3
            },
            {
                "body": "<p>Any thoughts on my last note?</p>",
                "wait_days": 4
            }
        ]
    }
}

Modified at 2026-08-15 09:43:13

Duplicate automation rule

Update Workspace Settings