Skip to content

overview.md

Latest commit

 

History

History
109 lines (65 loc) · 2.05 KB

overview.md

File metadata and controls

109 lines (65 loc) · 2.05 KB
title Overview
description Plane Sticky API overview. Learn about endpoints, request/response format, and how to work with sticky via REST API.
keywords plane api, sticky notes, quick notes, personal notes, workspace stickies, rest api, api integration

Overview

Stickies are workspace-level notes that allow you to capture quick thoughts, ideas, or important reminders.

Learn more about Stickies

The Sticky Object

Attributes

  • id uuid

    Unique identifier for the sticky

  • name string

    Name of the sticky

  • description object

    JSON description of the sticky

  • description_html string

    HTML description of the sticky

  • description_stripped string

    Stripped version of the HTML description

  • description_binary string

    Binary description of the sticky

  • logo_props object

    Logo properties for the sticky

  • color string

    Color of the sticky

  • background_color string

    Background color of the sticky

  • workspace uuid

    Workspace UUID which is automatically saved

  • owner uuid

    User ID of the sticky owner

  • sort_order number

    Sort order for the sticky

  • created_at timestamp

    The timestamp when the sticky was created

  • updated_at timestamp

    The timestamp when the sticky was last updated

  • created_by uuid

    ID of the user who created the sticky

  • updated_by uuid

    ID of the user who last updated the sticky

{
	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"created_at": "2023-11-19T11:56:55.176802Z",
	"updated_at": "2023-11-19T11:56:55.176809Z",
	"name": "Important Note",
	"description": {},
	"description_html": "<p>This is an important note</p>",
	"color": "#FF5733",
	"background_color": "#FFF9E6",
	"sort_order": 1000.0,
	"workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
	"owner": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}