API Keys and Integration Scopes

API Keys let you connect external tools to Site Service Pro integration endpoints without using an interactive user session.

Create an API Key

1. Go to Admin -> API Keys.
2. Enter a descriptive Key Name (example: n8n-work-items-sync).
3. Set optional expiration.
4. Select only the scopes required.
5. Create the key and copy it immediately.

The secret value is shown once at creation time.

Scope Planning (Least Privilege)

Available scopes:

• notes:read
• notes:write
• tasks:read
• tasks:write
• tasks:approve
• users:read

Suggested scope bundles:

• Notes sync: notes:read, notes:write
• Task intake integration: tasks:read, tasks:write, users:read
• Approval automation: tasks:approve, tasks:read, users:read

Endpoint Families

• Notes integrations: /api/notes/*
• Work Item integrations: /api/tasks/*

Use the minimum scope set that matches the endpoints you call.

Key Lifecycle Actions

From the API Keys admin page you can:

• Deactivate a key (temporary stop)
• Reactivate a key (restore use)
• Delete a key (permanent removal)

Use deactivation first when diagnosing production issues.

Troubleshooting Quick Checks

• 401 Unauthorized: invalid/expired/deactivated key
• 403 Forbidden: missing required scope
• No data: verify tenant/context and endpoint path

Security Checklist

• One key per integration workflow
• Name keys by owner + purpose
• Set expirations where practical
• Rotate keys on a schedule
• Remove unused keys quickly

Related Articles

• Notes Section: Personal, Project, and External Notes
• Tasks System (Work Items): End-to-End Guide