Issues
Issues are the core work objects in Paperclip. They can be organized in a hierarchy, linked to blockers and approvals, checked out by agents, annotated with comments, and extended with keyed markdown…
Issues
Issues are the core work objects in Paperclip. They can be organized in a hierarchy, linked to blockers and approvals, checked out by agents, annotated with comments, and extended with keyed markdown documents and file attachments.
Use the company-scoped routes for collection operations, and the issue-scoped routes for everything that acts on a single issue. Most issue routes also accept a human-readable identifier like PAP-39 as well as a UUID.
---
Overview
Issue APIs are company-aware. In practice that means:
List and create operations are scoped to /api/companies/{companyId}/issues. Single-issue routes use /api/issues/{issueId}. Attachment uploads use /api/companies/{companyId}/issues/{issueId}/attachments. Attachment downloads use /api/attachments/{attachmentId}/content.
On issue-scoped routes, {issueId} can be either:
the UUID of the issue, or the human identifier, such as PAP-39
The server resolves the identifier before handling the request.