Slugs and IDs
Address projects and documents by UUID or by their typed slug
Every record has a UUID id. Projects and most documents also have a
human-readable slug, numbered per organization, that endpoints accept wherever
their id parameter says it takes a slug.
| Prefix | Record | Example |
|---|---|---|
PRO- | Project | PRO-25 |
PRD- | Product requirements document | PRD-42 |
PLN- | Implementation plan | PLN-7 |
ISS- | Issue | ISS-1035 |
DOC- | Organization-level document | DOC-3 |
Issue slugs and FEA-
Issues used to be called features, and their older slugs start with FEA-. The
two prefixes share one counter, so ISS-1035 and FEA-1035 name the same issue,
and both resolve.
Templates
Templates have no typed prefix. Their slug is a random string, so address a
template by its id.
Users
Users have no slug. Endpoints that take a user, such as an assignee filter, take
the user's UUID. Call GET /me for
your own.
Document types on the wire
The API's document type values are PRD, IMPLEMENTATION_PLAN, FEATURE,
TEMPLATE, and DOC. The product calls a FEATURE an Issue. The document endpoints that take a type
as input also accept ISSUE and normalize it to FEATURE; responses always
report FEATURE.