Showcase and home page
Edit your public profile
What this is- Sign in, open Your sites, and go to Settings.
- Update your display name and bio. Keep contact details in the bio only if you want them public.
- To edit the bio from a client, send
PUT /v1/me/biowith{"bio":"Ceramics and workshops in York."}. - Open your public page in a signed-out browser and read it before sharing its address.
Pin and order sites
What this is- In Settings, find the showcase controls and choose a site you want to show.
- Tick Pin to top and set its order number. Put smaller numbers first among pinned sites, then among the remaining sites.
- With the API, send
PUT /v1/sites/{sitename}/showcasewith{"pinned":true,"order":10}. - Update the site’s title and description with the site’s editing controls if its card text needs changing. Check its visibility before looking for it on the public page; unlisted sites are omitted.
Choose a home page
What this is- Publish the site you want to use and test its links.
- Open Settings, then the Home page selector. Choose the site, or choose Showcase to use the listing again.
- With the API, send
PUT /v1/me/homewith{"site":"portfolio"}. Send{"site":null}to choose the showcase. - Open your person address and check the selected page. Keep the chosen site online.
Read your showcase feed
What this is- Request
GET /v1/u/{handle}/showcase.jsonwith your public handle. - Use the returned site links and ordering when building another page that lists your projects.
- Render titles and descriptions as text, and follow the returned URLs when opening a project.
Errors you may see
| Code | Means | Do this |
|---|---|---|
missing_api_key (401) |
Owner credential missing | Send the owner key in X-API-Key |
not_found (404) |
No matching owned site | Read the site list |
| HTTP 400 (no code) | Malformed setting | Check the response and request fields |
bio_too_long (400) |
Bio exceeds the limit | Shorten the bio |