> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.scripe.io/llms.txt > Use this file to discover all available pages before exploring further. # Read a project's 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. ## OpenAPI ````yaml /openapi/v1.yaml get /engagement-policy openapi: 3.1.0 info: title: Scripe Public API version: '2026-08-10' summary: >- Read and write Scripe workspace data — posts, notes, ideas, sources, knowledge, media, analytics, usage, async jobs, and webhooks. description: | The Scripe public API gives integrators stable, versioned access to a workspace's content surface: reads across every resource, synchronous writes (notes, posts, ideas, text sources, media assets), async jobs (post generation, file/URL/YouTube ingest, image and carousel generation), usage meters, and outbound webhooks. All endpoints (except `/v1/health`) require a Bearer token — either a workspace API key (`scripe_sk_*`) or an OAuth 2.1 access token (`scripe_oat_*`). Pin the API version with the `Scripe-Api-Version` request header to opt out of breaking changes. contact: name: Scripe Support url: https://scripe.io/support email: support@scripe.io license: name: Proprietary servers: - url: https://api.scripe.io/v1 description: Production security: - BearerApiKey: [] tags: - name: Health description: Liveness and authenticated key smoke tests. - name: Workspace description: The workspace + principal resolved from your API key. - name: Projects description: Personal-brand, company-page, and amplifier projects. - name: Notes description: Project notes with paired calendar slot. - name: Posts description: Drafts, scheduled, and published LinkedIn posts. - name: Analytics description: Your own LinkedIn analytics and viral-post inspiration search. - name: Sources description: Transcriptions (audio/video sources) with truncated body. - name: Uploads description: >- Pre-signed S3 PUT URLs the customer uploads bytes to before referencing via Sources or Knowledge. - name: Knowledge description: >- Knowledge-base documents indexed for RAG. Async ingest via text, file, URL, or YouTube. - name: Jobs description: >- Async-job lifecycle — submitted via post-generation, knowledge ingest, file source. - name: Calendar description: >- The content calendar — scheduled/planned posts, note slots, idea placements, and the posting-time template. - name: Ideas description: >- The idea board — creative briefs with derived workflow statuses and date-level calendar placement. - name: Media description: >- Media-library search, own-image imports, AI image generation, and full-state media writes onto posts. - name: Settings description: >- Curated project settings, engagement policy, and company pages (read-only over REST). - name: Webhooks description: | Outbound HTTP callbacks. Subscribe an endpoint to one or more event names; we POST a signed JSON payload every time a matching event fires in the workspace. The signing secret is shown once on create and once on rotate — verify the `Webhook-Signature: t=,v1=` header on every delivery. paths: /engagement-policy: get: tags: - Settings summary: Read a project's engagement policy description: | 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. operationId: getEngagementPolicy parameters: - $ref: '#/components/parameters/ScripeApiVersion' - name: projectId in: query required: true schema: type: string example: proj_a1b2c3d4e5f6g7h8 responses: '200': description: The project's engagement policy. content: application/json: schema: $ref: '#/components/schemas/EngagementPolicyResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' components: parameters: ScripeApiVersion: name: Scripe-Api-Version in: header required: false description: | Pin the API version. Format `YYYY-MM-DD`. Omit to receive the currently rolling default. Unknown versions return `400 version_unsupported`. schema: type: string example: '2026-08-10' schemas: EngagementPolicyResponse: type: object required: - data properties: data: type: object required: - projectId - policy - effective - overrides - canEnable - planLock properties: projectId: type: string example: proj_a1b2c3d4e5f6g7h8 policy: type: object nullable: true description: >- The stored `EngagementPolicy` row, or null when the project has none — which is the normal state of most projects, NOT a misconfiguration. Read `effective` to learn what actually happens; a null here means no consent row governs the project, so every engagement naming it as actor is declined. properties: likeDefault: $ref: '#/components/schemas/EngagementPolicyState' commentDefault: $ref: '#/components/schemas/EngagementPolicyState' reshareDefault: $ref: '#/components/schemas/EngagementPolicyState' reactionType: type: string nullable: true exampleComments: type: string nullable: true effective: type: object description: >- What happens under this project's LinkedIn identity right now, present whether or not a policy row exists. `source: no_policy` resolves to all-OFF because activation fails closed — the same behaviour as a stored all-OFF row, but a different fact: only a project with no row can still be seeded with the entitled defaults after a plan upgrade or LinkedIn reconnect. That is why the MCP `update_engagement_policy` tool writes no row when it disarms a project that has none. required: - likeDefault - commentDefault - reshareDefault - source properties: likeDefault: $ref: '#/components/schemas/EngagementPolicyState' commentDefault: $ref: '#/components/schemas/EngagementPolicyState' reshareDefault: $ref: '#/components/schemas/EngagementPolicyState' source: type: string enum: - policy - no_policy overrides: type: array items: type: object required: - requesterProjectId - likePolicy - commentPolicy - resharePolicy properties: requesterProjectId: type: string likePolicy: oneOf: - $ref: '#/components/schemas/EngagementPolicyState' - type: 'null' commentPolicy: oneOf: - $ref: '#/components/schemas/EngagementPolicyState' - type: 'null' resharePolicy: oneOf: - $ref: '#/components/schemas/EngagementPolicyState' - type: 'null' canEnable: type: boolean description: >- Stored LinkedIn-connection state — never a live probe. Not a write gate; activation still needs a token. planLock: type: object required: - locked - plan - feature properties: locked: type: boolean plan: type: string feature: type: string enum: - autoEngagement EngagementPolicyState: type: string enum: - 'OFF' - REQUEST - 'ON' Error: type: object required: - error properties: error: type: object required: - code - message - request_id - docs_url properties: code: type: string description: Stable, machine-readable error identifier. example: not_found message: type: string request_id: type: string example: req_a1b2c3d4e5f6 docs_url: type: string format: uri details: description: Optional structured payload — shape varies per code. responses: BadRequest: description: Malformed request (bad cursor, bad limit, etc.). content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Missing, malformed, expired, or revoked API key. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: Plan not eligible, scope missing, or workspace mismatch. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: Resource not found in this workspace. content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: Sliding-window rate limit exceeded. headers: Retry-After: schema: type: integer X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer X-RateLimit-Reset: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: BearerApiKey: type: http scheme: bearer bearerFormat: scripe_sk_live_* description: | 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. ````