Sharing & Collaboration
Share your pages and pinboards with the world or invite specific collaborators with granular permissions.
Sharing Methods
1. Public Sharing
Make your page or pinboard viewable by anyone with the link:
For Pages: Step 1: Open your page
Step 2: Click “Share” button
Step 3: Toggle “Make public”
Step 4: Copy the share link
For Pinboards: Step 1: Open your pinboard
Step 2: Click “Share” button
Step 3: Toggle “Make public”
Step 4: Copy the share link
Public Link Formats:
https://pindown.ai/share/pages/pg-abc123
https://pindown.ai/share/pinboard/pb-abc123Anyone with this link can view your page or pinboard - no login required!
2. Private Sharing (Invitations)
Invite specific people to collaborate:
Step 1: Click “Share” button
Step 2: Enter email address
Step 3: Choose role:
- Viewer: Can only view
- Editor: Can edit pins and layout
Step 4: Click “Send Invite”
They’ll receive an email with an invitation link!
3. Embed Sharing
Embed your page or pinboard in websites, blogs, or apps:
Step 1: Make page or pinboard public
Step 2: Click “Share” → “Embed” tab
Step 3: Copy embed code:
For Pages:
<iframe
src="https://pindown.ai/share/pages/pg-abc123/embed"
width="100%"
height="600"
frameborder="0">
</iframe>For Pinboards:
<iframe
src="https://pindown.ai/share/pinboard/pb-abc123/embed"
width="100%"
height="600"
frameborder="0">
</iframe>Step 4: Paste into your HTML
Permission Levels
| Role | View | Edit Pins | Edit Layout/Content | Invite Others | Delete |
|---|---|---|---|---|---|
| Owner | ✅ | ✅ | ✅ | ✅ | ✅ |
| Editor | ✅ | ✅ | ✅ | ❌ | ❌ |
| Viewer | ✅ | ❌ | ❌ | ❌ | ❌ |
| Public | ✅ | ❌ | ❌ | ❌ | ❌ |
Owner Permissions
As the page or pinboard owner, you can:
- ✅ Edit all content
- ✅ Change sharing settings
- ✅ Invite collaborators
- ✅ Remove collaborators
- ✅ Delete the page or pinboard
Editor Permissions
Editors can:
- ✅ View the page or pinboard
- ✅ Add new pins
- ✅ Edit existing pins
- ✅ Rearrange pin layout (pinboards) or pin order (pages)
- ✅ Resize pins (pinboards only)
- ❌ Delete the page or pinboard
- ❌ Change sharing settings
- ❌ Invite others
Viewer Permissions
Viewers can:
- ✅ View the page or pinboard
- ✅ See all pins and data
- ✅ Refresh data
- ❌ Edit anything
- ❌ Invite others
Public Access
Public viewers can:
- ✅ View the page or pinboard via link
- ✅ See all public pins
- ❌ Need to sign in (optional - you choose)
- ❌ Edit anything
Custom Roles (Advanced - Pinboards Only)
Control which collaborators can see specific pins with custom roles. This advanced RBAC feature is available for pinboards only and is perfect for:
- 🔐 VIP Content - Show premium content only to VIP members
- 👥 Team Sections - Different teams see different pins on the same board
- 📊 Access Levels - Free vs. Paid tiers with different content
- 🎯 Role-Based Dashboards - Executives, Managers, Staff see different views
How Custom Roles Work
- Create Custom Roles - Define roles like “VIP Members”, “Premium Users”, “Team Leads”
- Assign Roles to Collaborators - Give specific users one or more custom roles
- Set Pin Requirements - Mark pins as requiring specific roles to view
- Automatic Filtering - Users only see pins they have permission to access
Setting Up Custom Roles
Step 1: Create a Role
- Open your pinboard settings
- Go to “Custom Roles” tab
- Click “Create Role”
- Enter role name (e.g. “VIP Members”)
- Choose a color for visual identification
- Save the role
Or via API:
curl -X POST https://api.pindown.ai/api/pinboards/pb-abc123/roles \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "VIP Members",
"color": "#FFD700"
}'Step 2: Assign Roles to Collaborators
- Go to “Collaborators” section
- Select a collaborator
- Click “Assign Custom Roles”
- Check the roles they should have
- Save changes
Or via API:
curl -X PUT https://api.pindown.ai/api/pinboards/pb-abc123/users/u-xyz789/custom-roles \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"roleIds": ["role-vip123", "role-premium456"]
}'Step 3: Protect Pins
- Open a pin’s settings
- Go to “Visibility” tab
- Select “Require custom roles”
- Choose which roles can see this pin
- Save the pin
Or via API:
curl -X PUT https://api.pindown.ai/api/pinboards/pb-abc123/pins/p-pin789/required-roles \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"roleIds": ["role-vip123"]
}'Custom Roles Example
Scenario: Create a dashboard with public and VIP-only content
Setup:
- Create pinboard: “Product Dashboard”
- Create role: “VIP Members” (#FFD700)
- Add public pins (no role requirements)
- Add VIP-only pins (require “VIP Members” role)
- Invite regular users as Viewers (see only public pins)
- Invite VIP users as Viewers + assign “VIP Members” role (see all pins)
Result:
- Regular viewers see only public pins
- VIP members see public + VIP-only pins
- Owner always sees all pins
Custom Roles Rules
- Maximum 5 roles per pinboard
- Owner always sees all pins regardless of role requirements
- Multiple role requirements = User needs ALL roles (AND logic)
- Users must be invited first before assigning custom roles
- Deleting a role removes it from all users and pins automatically
Permission Matrix with Custom Roles
| User Type | Create Roles | Assign Roles | View All Pins | Set Pin Requirements |
|---|---|---|---|---|
| Owner | ✅ | ✅ | ✅ Always | ✅ |
| Editor | ❌ | ❌ | Only assigned roles | ❌ |
| Viewer | ❌ | ❌ | Only assigned roles | ❌ |
Learn More
- Custom Roles API Reference - Full API documentation
- Custom Roles Guide - Complete examples and use cases
Invitation Management
Send Invitations
# Via API
POST /v1/pinboards/pb-abc123/invitations/send
{
"email": "colleague@company.com",
"role": "editor"
}View Pending Invitations
# Via API
GET /v1/pinboards/pb-abc123/invitationsResponse:
{
"success": true,
"data": {
"pending": [
{
"email": "colleague@company.com",
"role": "editor",
"invited_at": "2024-11-01T10:00:00Z",
"expires_at": "2024-11-08T10:00:00Z"
}
],
"granted": [
{
"userId": "u-xyz789",
"email": "teammate@company.com",
"role": "viewer",
"displayName": "Jane Doe"
}
]
}
}Revoke Invitations
# Via API
DELETE /v1/pinboards/pb-abc123/invitations/colleague@company.comRemove Collaborators
# Via API
DELETE /v1/pinboards/pb-abc123/collaborators/u-xyz789Privacy Settings
Require Sign-In
Force users to log in before viewing (even if public):
When to use:
- Track who’s viewing
- Restrict to registered users only
- Add analytics
How to enable:
- Make pinboard public
- Toggle “Require sign-in”
- Share link - visitors must login first
Password Protection
Coming soon! Protect pinboards with a password.
Expiring Links
Coming soon! Generate links that expire after X days.
Sharing Individual Pins
You can also share individual pins:
Share a Single Pin
Step 1: Open the pin detail page
Step 2: Click “Share”
Step 3: Choose sharing method:
- Public link
- Email invitation
- Embed code
Public Pin Link:
https://pindown.ai/share/pin/p-abc123Pin vs Page vs Pinboard Sharing
| Feature | Pin Share | Page Share | Pinboard Share |
|---|---|---|---|
| URL | /share/pin/p-* | /share/pages/pg-* | /share/pinboard/pb-* |
| Shows | Single pin only | All pins on page | All pins on board |
| Layout | Pin detail view | Sequential layout | Grid layout |
| Updates | Real-time | Real-time | Real-time |
| Permissions | Same as parent | Owner-controlled | Owner-controlled |
Collaboration Workflows
Workflow 1: Team Dashboard
Scenario: Sales team needs a shared dashboard
Setup:
- Create page or pinboard: “Q4 Sales Dashboard”
- Add KPI pins (revenue, deals, pipeline)
- Invite team as Viewers
- Invite managers as Editors
Result:
- Everyone sees same real-time data
- Managers can adjust content/layout
- Team members can’t mess things up
Workflow 2: Client Reporting
Scenario: Show clients their metrics
Setup:
- Create page or pinboard per client
- Make Public
- Enable “Require sign-in”
- Share link with client
Result:
- Client logs in to see their data
- No editing access
- You track who viewed when
Workflow 3: Executive Dashboard
Scenario: C-level needs high-level metrics
Setup:
- Create page or pinboard: “Executive KPIs”
- Add key metrics from all departments
- Invite execs as Viewers
- Keep Private (invitation only)
Result:
- Execs see all critical metrics
- No public access
- Clean, read-only view
Workflow 4: Embedded Analytics
Scenario: Show metrics on your company website
Setup:
- Create page or pinboard: “Company Stats”
- Make Public
- Don’t require sign-in
- Embed on website
Result:
- Public sees your metrics
- Updates in real-time
- No Pindown account needed
Security Best Practices
1. Use Minimum Permissions
Give users only what they need:
- ✅ Viewer for most people
- ✅ Editor for trusted collaborators
- ❌ Don’t make everything public
2. Review Collaborators Regularly
Check who has access:
- Remove former employees
- Revoke unused invitations
- Audit permission levels
3. Use Private Pages/Pinboards for Sensitive Data
If data is confidential:
- ❌ Don’t make public
- ❌ Don’t embed publicly
- ✅ Use invitations only
- ✅ Enable sign-in requirement
4. Monitor Access Logs
Coming soon! View who accessed what and when.
5. Rotate Share Links
If a link is compromised:
- Make page or pinboard private
- Create new page or pinboard
- Update share links
- Revoke old invitations
Sharing via API
Make Page or Pinboard Public
For Pages:
curl -X POST https://api.pindown.ai/v1/pages/pg-abc123/publish \
-H "Authorization: Bearer YOUR_API_KEY"For Pinboards:
curl -X POST https://api.pindown.ai/v1/pinboards/pb-abc123/publish \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"is_public": true,
"require_sign_in": false,
"allow_comments": false
}'Make Page or Pinboard Private
For Pages:
curl -X POST https://api.pindown.ai/v1/pages/pg-abc123/unpublish \
-H "Authorization: Bearer YOUR_API_KEY"For Pinboards:
curl -X POST https://api.pindown.ai/v1/pinboards/pb-abc123/unpublish \
-H "Authorization: Bearer YOUR_API_KEY"Send Invitation
For Pages:
curl -X POST https://api.pindown.ai/v1/pages/pg-abc123/invitations/send \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"role": "editor"
}'For Pinboards:
curl -X POST https://api.pindown.ai/v1/pinboards/pb-abc123/invitations/send \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"role": "editor"
}'Change Collaborator Role
For Pages:
curl -X PUT https://api.pindown.ai/v1/pages/pg-abc123/users/u-xyz789/role \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"role": "viewer"
}'For Pinboards:
curl -X PUT https://api.pindown.ai/v1/pinboards/pb-abc123/collaborators/u-xyz789 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"role": "viewer"
}'Troubleshooting
Invitation email not received
- Check spam folder
- Verify email address is correct
- Resend invitation
- Check email service status
Can’t make page or pinboard public
- Check you’re the owner
- Check API key has
pages:writeorpinboards:writescope - Verify page or pinboard exists
Collaborator can’t edit
- Check they’re assigned “editor” role
- They might only be “viewer”
- Check they’re logged in
- Refresh the page
Embed not showing
- Page or pinboard must be public
- Check iframe src URL
- Check website allows iframes
- Try opening embed URL directly
Next Steps
- Builder - Create content from your data
- Pages API Reference - Pages sharing API docs
- Pinboards API Reference - Pinboards sharing API docs
- 💬 Discord: Join our community
- 🔑 API Keys: Manage your API keys