3 endpoints. Send your API key as Authorization: Bearer <key> on each request; see The API and AI assistants for keys, errors, idempotency and the conventions every endpoint shares.
GET /api/projects/{id}/share
The project's live client page link, if any (never the link itself)
Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | From 1 to 2147483647. |
Responses:
| Status | Meaning |
|---|---|
| 200 | {share}: the live link's id, fields, expires_at, created_at, created_by_name and disabled, or null. |
| 401 | Missing or invalid API key (Error) |
| 404 | Item (or its parent) does not exist (Error) |
POST /api/projects/{id}/share
Make a client page link (admins); it replaces any live one
understood must be true: anyone with the link can see the page. fields picks what it shows, from progress, phases, tasks, due_dates and description (default: progress and phases). People, comments, issues and attachments are never shown. expires_on (optional) is the last day the link works. The answer's url is shown this once: only a hash of the link is kept.
Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | From 1 to 2147483647. |
X-Actor | header | string | No | Name recorded in the activity log (up to 200 characters, URI-encoded if not ASCII). |
Request body (application/json, required).
| Field | Type | Required | Description |
|---|---|---|---|
understood | boolean | Yes | One of: true. |
fields | array of string | No | |
expires_on | string or null (date) | No |
Responses:
| Status | Meaning |
|---|---|
| 201 | The link: id, fields, expires_at, url (shown once) |
| 400 | The request body is invalid or is not valid JSON (Error) |
| 401 | Missing or invalid API key (Error) |
| 403 | Admins only |
| 404 | Item (or its parent) does not exist (Error) |
DELETE /api/projects/{id}/share
End the project's client page link at once (admins)
Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | From 1 to 2147483647. |
Responses:
| Status | Meaning |
|---|---|
| 200 | {revoked}: true when a live link was ended |
| 401 | Missing or invalid API key (Error) |
| 403 | Admins only |
| 404 | Item (or its parent) does not exist (Error) |