Skip to content

Commit 8e24988

Browse files
committed
Add a new Pins section to docs/API.md covering pin/unpin and the pinned cards list response.
1 parent 5384116 commit 8e24988

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

docs/API.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -803,6 +803,79 @@ __Response:__
803803

804804
Returns `204 No Content` on success.
805805

806+
## Pins
807+
808+
Pins let users keep quick access to important cards.
809+
810+
### `POST /:account_slug/cards/:card_number/pin`
811+
812+
Pins a card for the current user.
813+
814+
__Response:__
815+
816+
Returns `204 No Content` on success.
817+
818+
### `DELETE /:account_slug/cards/:card_number/pin`
819+
820+
Unpins a card for the current user.
821+
822+
__Response:__
823+
824+
Returns `204 No Content` on success.
825+
826+
### `GET /my/pins`
827+
828+
Returns the current user's pinned cards. This endpoint is not paginated and returns up to 100 cards.
829+
830+
__Response:__
831+
832+
```json
833+
[
834+
{
835+
"id": "03f5vaeq985jlvwv3arl4srq2",
836+
"number": 1,
837+
"title": "First!",
838+
"status": "published",
839+
"description": "Hello, World!",
840+
"description_html": "<div class=\"action-text-content\"><p>Hello, World!</p></div>",
841+
"image_url": null,
842+
"tags": ["programming"],
843+
"golden": false,
844+
"last_active_at": "2025-12-05T19:38:48.553Z",
845+
"created_at": "2025-12-05T19:38:48.540Z",
846+
"url": "http://fizzy.localhost:3006/897362094/cards/4",
847+
"board": {
848+
"id": "03f5v9zkft4hj9qq0lsn9ohcm",
849+
"name": "Fizzy",
850+
"all_access": true,
851+
"created_at": "2025-12-05T19:36:35.534Z",
852+
"url": "http://fizzy.localhost:3006/897362094/boards/03f5v9zkft4hj9qq0lsn9ohcm",
853+
"creator": {
854+
"id": "03f5v9zjw7pz8717a4no1h8a7",
855+
"name": "David Heinemeier Hansson",
856+
"role": "owner",
857+
"active": true,
858+
"email_address": "david@example.com",
859+
"created_at": "2025-12-05T19:36:35.401Z",
860+
"url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7",
861+
"avatar_url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7/avatar"
862+
}
863+
},
864+
"creator": {
865+
"id": "03f5v9zjw7pz8717a4no1h8a7",
866+
"name": "David Heinemeier Hansson",
867+
"role": "owner",
868+
"active": true,
869+
"email_address": "david@example.com",
870+
"created_at": "2025-12-05T19:36:35.401Z",
871+
"url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7",
872+
"avatar_url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7/avatar"
873+
},
874+
"comments_url": "http://fizzy.localhost:3006/897362094/cards/4/comments"
875+
}
876+
]
877+
```
878+
806879
## Comments
807880

808881
Comments are attached to cards and support rich text.

0 commit comments

Comments
 (0)