POST /teams/{teamId}/boards/{id}/public-shares
Cria um link publico somente-leitura do board
- Access: Team admin
- Service:
https://api-workspace.axuz.net
Accepted authentication
sessionCookie— Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.bearerSession— JWT de acesso da sessão em `Authorization: Bearer`.
Apenas owner/admin do team. Todos os flags default false (deny-by-default: o titulo, a coluna e a prioridade das tarefas sao sempre expostos; o resto o dono liga). Maximo de 20 links ativos por board (422 too many active shares). expires_at opcional, no futuro e a no maximo 365 dias; omitido = 30 dias (nunca eterno por omissao); link sem validade so com no_expiry: true (exclusivo com expires_at, senao 400). Emite board.public_share.created (sem token, sem hash).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes | |
id | path | string | yes | No servico o segmento e |
Request body
application/json · Required
| Name | Type | Required | Description |
|---|---|---|---|
show_assignees | boolean | no | |
show_due_dates | boolean | no | |
show_descriptions | boolean | no | |
expires_at | string<date-time> | null | no | Ausente = 30 dias (default). Deve ser futuro e <= 365 dias. Null equivale a ausente. |
no_expiry | boolean | no | Opt-in explicito para link sem validade. Exclusivo com expires_at (400). |
{
"show_assignees": false,
"show_due_dates": false,
"show_descriptions": false,
"expires_at": "2026-01-15T12:00:00Z",
"no_expiry": false
}Responses
201
Criado. O campo token aparece SOMENTE nesta resposta.
| Name | Type | Required | Description |
|---|---|---|---|
id | string<uuid> | yes | |
board_id | string<uuid> | yes | |
show_assignees | boolean | yes | |
show_due_dates | boolean | yes | |
show_descriptions | boolean | yes | |
expires_at | string<date-time> | null | yes | |
revoked_at | string<date-time> | null | yes | |
status | string | yes | enum: |
created_by | string<uuid> | yes | |
created_at | string<date-time> | yes | |
token | string | yes | Credencial do link. Mostrada UMA vez. O link publico e |
400
Erro no formato do servico.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
401
Erro no formato do servico.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Erro no formato do servico.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
404
Erro no formato do servico.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
422
Erro no formato do servico.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
429
Rate limit.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes | |
retry_after | integer | yes |
500
Erro interno. Tente de novo com backoff; reporte o X-Request-Id.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
curl
curl -sS -X POST 'https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/public-shares' \
-H "Authorization: Bearer $AXUZ_TOKEN" \
-H "Content-Type: application/json" \
-d '{"show_assignees":false,"show_due_dates":false,"show_descriptions":false,"expires_at":"2026-01-15T12:00:00Z","no_expiry":false}'Node.js
const res = await fetch("https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/public-shares", {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"show_assignees": false,
"show_due_dates": false,
"show_descriptions": false,
"expires_at": "2026-01-15T12:00:00Z",
"no_expiry": false
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());Python
import os
import requests
res = requests.request(
"POST",
"https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/public-shares",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
json={
"show_assignees": False,
"show_due_dates": False,
"show_descriptions": False,
"expires_at": "2026-01-15T12:00:00Z",
"no_expiry": False,
},
timeout=30,
)
res.raise_for_status()
print(res.json())