Tài liệu tham khảo API
agency-board
Có 89 điểm cuối trong khu vực này. Mỗi điểm cuối có một trang riêng với các tham số, phản hồi và yêu cầu mà quý vị có thể thực hiện.
| Phương thức | Đường dẫn | Chức năng | Quyền |
|---|---|---|---|
| GET | /v1/agency/board-automation-catalogue | What a rule can be built out of. | Bất kỳ khóa API nào |
| GET | /v1/agency/board-clients | The organisations a board may be for. | org.read |
| GET | /v1/agency/boards | The agency's project boards. | agency.board.view |
| POST | /v1/agency/boards | Create a project board. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId} | Archive a board. | agency.board.manage |
| GET | /v1/agency/boards/{boardId} | One board, with its columns, cards and labels. | agency.board.view |
| PATCH | /v1/agency/boards/{boardId} | Rename a board or attach a client organisation to it. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/activity | The board's timeline. | agency.board.view |
| GET | /v1/agency/boards/{boardId}/ai/models | The models this org may choose from, cheapest first. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/ai/run | Run one AI function on this board. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/ai/runs | What the AI did on this board, refusals included. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/ai/settings | What AI this board has turned on. | agency.board.manage |
| PATCH | /v1/agency/boards/{boardId}/ai/settings | Turn auto-triage or the standup digest on or off. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/automation-runs | Every rule's history on this board, together. | agency.board.view |
| GET | /v1/agency/boards/{boardId}/automations | The board's automation rules. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/automations | Create a rule — when this happens, only if that, then do these. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/automations/{ruleId} | Delete a rule and its history. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/automations/{ruleId} | One rule. | agency.board.view |
| PATCH | /v1/agency/boards/{boardId}/automations/{ruleId} | Change a rule, or pause and resume it. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/automations/{ruleId}/runs | Every time this rule was considered — and why it did or did not fire. | agency.board.view |
| GET | /v1/agency/boards/{boardId}/cards | The board's cards. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/cards | Add a payment method. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/cards/{cardId} | Archive a card. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/cards/{cardId} | One card, with its comments and questions. | agency.board.view |
| PATCH | /v1/agency/boards/{boardId}/cards/{cardId} | Edit a card. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/cards/{cardId}/attachments | The files on a card, with the organisation's storage quota. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/cards/{cardId}/attachments | Attach a file to a card. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId} | Delete a file and its bytes. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId} | The file's bytes, if it has passed a scan. | agency.board.view |
| PATCH | /v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId} | Choose whether the client can see this file. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/cards/{cardId}/checklist | The card's checklist. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/cards/{cardId}/checklist | Append one line to the card's checklist. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId} | Remove one checklist item. | agency.board.manage |
| PATCH | /v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId} | Tick or un-tick one checklist item. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/cards/{cardId}/comments | Comment on a card. | agency.board.comment |
| PUT | /v1/agency/boards/{boardId}/cards/{cardId}/labels | Set the labels on a card. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/cards/{cardId}/move | Move a card to a column and position. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/cards/{cardId}/questions | Ask the client a question about this card. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/cards/{cardId}/restore | Take a card back out of the archive. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/columns | The board's columns. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/columns | Add a column. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/columns/{columnId} | Delete an empty column. | agency.board.manage |
| PATCH | /v1/agency/boards/{boardId}/columns/{columnId} | Rename a column, change what the client sees, or make it the intake column. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/columns/{columnId}/move | Reorder a column in the board's strip. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/event-subscriptions | Which Zinn® platform events create cards on this board. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/event-subscriptions | Turn a platform event on for this board. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/event-subscriptions/{subscriptionId} | Stop this event creating cards on this board. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/inbound-endpoints | The URLs n8n, Zapier and Make POST to. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/inbound-endpoints | Create an inbound endpoint. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId} | Delete an endpoint and forget its secret. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId} | One inbound endpoint. | agency.board.view |
| PATCH | /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId} | Rename an endpoint, or pause and resume it. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}/rotate | Mint a new secret for an inbound endpoint. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/inbound-requests | What arrived on this board's endpoints — accepted and refused. | agency.board.view |
| GET | /v1/agency/boards/{boardId}/invites | The share links for this board. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/invites | Mint a copy-paste link to this board. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/invites/{inviteId} | Revoke a share link, and everybody who joined through it. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/labels | The board's label vocabulary. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/labels | Define a label. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/labels/{labelId} | Delete a label, taking it off every card wearing it. | agency.board.manage |
| PATCH | /v1/agency/boards/{boardId}/labels/{labelId} | Rename or recolour a label. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/members | Who is on this board, and who has been invited. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/members | Put somebody on a board, or invite them by email. | agency.board.manage, members.invite |
| DELETE | /v1/agency/boards/{boardId}/members/{memberId} | Take somebody off a board. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/questions/{questionId} | Withdraw a question. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/questions/{questionId} | Record an answer the agency was given another way. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/views | The board's saved views. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/views | Create or replace a named cut of the board. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/views/{viewId} | Delete a saved view. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/webhook-deliveries | What we sent, when, and what came back. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/webhook-deliveries/{deliveryId}/replay | Send the same payload again. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/webhooks | Where this board POSTs when something happens. | agency.board.view |
| POST | /v1/agency/boards/{boardId}/webhooks | Add an outbound webhook. | agency.board.manage |
| DELETE | /v1/agency/boards/{boardId}/webhooks/{webhookId} | Delete a webhook and forget its secret. | agency.board.manage |
| GET | /v1/agency/boards/{boardId}/webhooks/{webhookId} | One webhook subscription. | agency.board.view |
| PATCH | /v1/agency/boards/{boardId}/webhooks/{webhookId} | Change a webhook, or pause and resume it. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate | Mint a new signing secret. | agency.board.manage |
| POST | /v1/agency/boards/{boardId}/webhooks/{webhookId}/test | Send a signed test delivery now. | agency.board.manage |
| GET | /v1/agency/client/boards | Boards my agency has shared with us. | agency.board.client_view |
| GET | /v1/agency/client/boards/{boardId} | The client's view of one board. | agency.board.client_view |
| GET | /v1/agency/client/boards/{boardId}/activity | What has happened on the shared board. | agency.board.client_view |
| POST | /v1/agency/client/boards/{boardId}/cards/{cardId}/comments | Comment on a shared card. | agency.board.client_view |
| POST | /v1/agency/client/boards/{boardId}/questions/{questionId}/answer | Answer a question the agency asked. | agency.board.client_view |
| POST | /v1/agency/client/boards/{boardId}/requests | Raise a request with the agency. | agency.board.client_view |
| POST | /v1/board-hooks/{endpointKey} | The public inbound door — n8n, Zapier, Make, GitHub. | Không có khóa API |
| GET | /v1/boards/brand | The branding your shared boards carry. | agency.board.view |
| PUT | /v1/boards/brand | Set the branding your shared boards carry. | agency.board.manage |
| DELETE | /v1/boards/brand/logo | Take the mark off future shared boards. | agency.board.manage |
| POST | /v1/boards/brand/logo | Upload the mark your shared boards show. | agency.board.manage |