Meet the new Scripe, live on October 7.Register

OpenAPI reference · Settings

Read a project's engagement policy

GET/engagement-policy

The stored auto-like/comment/reshare defaults (OFF | REQUEST | ON), per-requester overrides, whether engagement CAN be enabled (stored LinkedIn-connection state — never a live probe), and the plan-lock state. The lock rides the output, so locked workspaces can still read what would unlock.

Answer "is anything engaging as this project?" from effective, never from policy: a null policy is the normal state of most projects and means nothing engages, which effective reports as all-OFF with source: no_policy. Requires the workspace:read scope.

Authorization

  • Authorizationstringrequired

    Bearer token in the Authorization header.

    Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

    The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Query parameters

  • projectIdstringrequired

Header parameters

  • Scripe-Api-Versionstring

    Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Responses

  • 200

    The project's engagement policy.

  • 400

    Malformed request (bad cursor, bad limit, etc.).

  • 401

    Missing, malformed, expired, or revoked API key.

  • 403

    Plan not eligible, scope missing, or workspace mismatch.

  • 404

    Resource not found in this workspace.

  • 429

    Sliding-window rate limit exceeded.

Example request

bash
curl --request GET \
  --url 'https://api.scripe.io/v1/engagement-policy?projectId=<projectId>' \
  --header 'Authorization: Bearer <token>'

Example response (200)

json
{
  "data": {
    "projectId": "proj_a1b2c3d4e5f6g7h8",
    "policy": {
      "likeDefault": "OFF",
      "commentDefault": "OFF",
      "reshareDefault": "OFF",
      "reactionType": "string",
      "exampleComments": "string"
    },
    "effective": {
      "likeDefault": "OFF",
      "commentDefault": "OFF",
      "reshareDefault": "OFF",
      "source": "policy"
    },
    "overrides": [
      {
        "requesterProjectId": "string",
        "likePolicy": "OFF",
        "commentPolicy": "OFF",
        "resharePolicy": "OFF"
      }
    ],
    "canEnable": true,
    "planLock": {
      "locked": true,
      "plan": "string",
      "feature": "autoEngagement"
    }
  }
}