Skip to content

overview.md

Latest commit

 

History

History
77 lines (49 loc) · 1.81 KB

overview.md

File metadata and controls

77 lines (49 loc) · 1.81 KB
title Overview
description Plane Link API overview. Learn about endpoints, request/response format, and how to work with link via REST API.
keywords plane api, rest api, work item links, issue links, url references, link management, plane integration

Overview

Links attach external resources to work items, allowing you to reference documentation, designs, or other relevant URLs.

Learn more about Links

The Link Object

Attributes

  • title string

    Title of the url

  • url url (required)

    Url of the external link

  • metadata json

    Metadata from the resource

  • created_at , updated_at timestamp

    Timestamp of the issue when it was created and when it was last updated.

  • created_by & updated_by

    This values are auto saved and represent the id of the user that created or the updated the project.

  • project uuid

    The project which the issue is part of auto generated from backend

  • workspace uuid

    The workspace which the issue is part of auto generated from backend

  • issue uuid

    The issue which the link is attached to

{
	"id": "662dd6b2-2b01-4315-955f-480eb51baa14",
	"created_at": "2023-11-20T06:23:10.270664Z",
	"updated_at": "2023-11-20T06:23:10.270689Z",
	"title": "Plane Website",
	"url": "https://plane.so",
	"metadata": {},
	"created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
	"updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
	"project": "4af68566-94a4-4eb3-94aa-50dc9427067b",
	"workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
	"issue": "e1c25c66-5bb8-465e-a818-92a483423443"
}