Skip to content
Pealboard
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Help documentation
Getting started
The six steps
Sign up
Create a workspace
Connect GitHub
Choose repositories
Where new issues go
The first sync
Workspaces and members
Workspaces
Roles
Invitations
Issues
List, table and board
Filters and saved views
Search
Create and edit an issue
Comments
Split into sub-issues
Bulk edit
Projects and fields
Portals
Create a portal
Request types and forms
Destinations
Statuses
Visibility
Companies and customers
Branding
Public replies
Attachments
The hold queue
Notifications
API keys
Account
Billing
Troubleshooting
Glossary
Developer documentation
Overview
Authentication
Errors
Rate limits
Pagination
Idempotency
GitHub
Webhooks
API reference
Overview
Account
Overview
Where a failed sign-in lands
GET
Begin Continue with GitHub
GET
Hand a finished sign-in back to the app
GET
Exchange the code for a session
POST
The signed-in person
GET
Delete my account
DELETE
Change your name, or how your writes are authored
PATCH
Workspaces this person belongs to
GET
Sign out on every device
POST
The acting credential
GET
Workspaces
Overview
Create a workspace
POST
The current workspace
GET
Change the workspace
PATCH
Delete the workspace
DELETE
Members
Overview
List members
GET
Remove a member
DELETE
Change a member's role
PATCH
Invitations that have not been used
GET
Invite someone to the workspace
POST
Revoke an invitation
DELETE
What an invitation is for
POST
Accept an invitation
POST
GitHub
Overview
Where to install the Pealboard App
GET
Finish connecting GitHub
GET
GitHub installations you can connect
GET
The GitHub connection
GET
Connect a GitHub installation
POST
Disconnect GitHub
DELETE
GitHub's OAuth callback
GET
Repositories the installation can see
GET
Choose which repositories to mirror
PATCH
Which repository to default to
GET
Sync now
POST
What sync is doing
GET
GitHub webhooks
POST
Issues
Overview
List issues across every repository
GET
Create an issue
POST
Edit up to fifty issues
POST
One issue
GET
Edit an issue
PATCH
An issue's sub-issues
GET
Split an issue into sub-issues
POST
List an issue's comments
GET
Comment on an issue
POST
Delete a comment you wrote
DELETE
Edit a comment you wrote
PATCH
An issue's activity
GET
Projects
Overview
List projects
GET
Create a project
POST
One project
GET
Delete a project
DELETE
Edit a project
PATCH
List a project's items
GET
Add an issue to a project
POST
Remove an item from a project
DELETE
Set or clear a field value
PATCH
Move an item within the project
POST
Labels
Overview
List labels
GET
Create a label
POST
Milestones
Overview
List milestones
GET
Create a milestone
POST
Views
Overview
List views
GET
Create a view
POST
One view
GET
Delete a view
DELETE
Edit a view
PATCH
Run a view
GET
Run a view as a board
GET
Portals
Overview
List portals
GET
Create a portal
POST
A portal
GET
Delete a portal
DELETE
Change a portal
PATCH
List request types
GET
Create a request type
POST
Delete a request type
DELETE
Change a request type
PATCH
List companies
GET
Create a company
POST
Delete a company
DELETE
Change a company
PATCH
List customers
GET
Invite a customer
POST
Remove a customer
DELETE
Change a customer's role or company
PATCH
List requests
GET
Share an issue to a portal
POST
A request
GET
Remove a request from a portal
DELETE
Change a request's visibility or company
PATCH
Release a request from the hold queue
POST
Reject a request from the hold queue
POST
Portal
Overview
Where a failed portal sign-in lands
GET
The portal, before signing in
GET
Who this customer is
GET
Delete my account
DELETE
Download my data
GET
My requests
GET
Submit a request
POST
A request
GET
Add a comment
POST
Vote
POST
Take back a vote
DELETE
Email me about this request
POST
Stop emailing me about this request
DELETE
Stop emailing me, from a link in an email
POST
Upload a file
POST
A fresh link to a file
GET
Delete a file
DELETE
Invite a colleague
POST
Notifications
Overview
The Inbox
GET
Mark notifications read
POST
Integrations
Overview
The Slack webhook
GET
Set the Slack webhook
PUT
Remove the Slack webhook
DELETE
Send a test message
POST
Attachments
Overview
Upload a file
POST
A fresh link to a file
GET
Delete a file
DELETE
Download a file
GET
Billing
Overview
The workspace's billing
GET
Start a checkout
POST
Open the billing portal
POST
Start the 14-day trial
POST
Stripe's webhook
POST
Read the subscription back from Stripe
POST
API keys
Overview
List API keys
GET
Issue an API key
POST
Revoke an API key
DELETE
Audit log
Overview
Read the audit log
GET
SDK
MCP
Changelog
Elsewhere
Product site
Pricing
Changelog
Install the GitHub App
Select theme
Dark
Light
Auto
Overview
GitHub
Section titled “GitHub”
The App installation, the repositories it covers, and the state of the sync.
Operations
Section titled “Operations”
GET
/v1/github/install-url
GET
/github/setup
GET
/v1/github/installations/available
GET
/v1/github/installation
POST
/v1/github/installation
DELETE
/v1/github/installation
GET
/github/callback
GET
/v1/github/repositories
PATCH
/v1/github/repositories
GET
/v1/github/default-repository/suggestion
POST
/v1/github/sync
GET
/v1/github/sync-status
POST
/webhooks/github
