shared-boards

Shared Menu Item Detail

get/v3.0/shared-boards/{boardShareAddress}/blocks/{blockSlug}/items/{itemSlug}/

Request

  • Base URL: https://api.formaloo.me
  • URL: https://api.formaloo.me/v3.0/shared-boards/{boardShareAddress}/blocks/{blockSlug}/items/{itemSlug}/
  • Auth: none declared. Required headers: x-api-key

Path parameters

blockSlugstring required
boardShareAddressstring required
itemSlugstring required

Headers

x-api-keystring required

The application secret provided to the client.

Response

sub_itemsobject
iconstring
rolesstring[]
teamsstring[]
blocksobject
created_atstring date-time
updated_atstring date-time
slugstring nullable
titlestring required
positioninteger
page_titlestring nullable

page title for the page represented by this item.

type'block' | 'link' | 'embed' | 'group' required
linkstring uri nullable

the link to which the menu item is set.

descriptionstring nullable

an optional description on the menu item.

contentobject

enter your content here. It should be in json format.

cover_slugstring nullable

the cover's slug.

cover_urlstring nullable

the cover's url.

configobject nullable
colorstring nullable

color of item

workspace_access'owner' | 'admin' | 'team_member' | 'guest'
access_settingsobject nullable
copy_infoobject nullable
suspiciousboolean

Shows wether the board contains any suspicious menu items.

Changes

No recorded changes to this operation across all 1 revision of this API.