Skip to content

Commit b793a98

Browse files
Prashant-Suryadanciaclara
Prashant-Surya
and
danciaclara
authored
docs: restructure API docs and update Work Item terminology (#163)
* docs: restructure API docs and update Work Item terminology - Add Users and Stickies API documentation - Add Initiatives, Teamspaces and Pages API documentation - Add Customers, Customer Requests and Properties API documentation - Update WorkItemTypes: replace "Issue" with "Work Item", fix endpoints - Reorganize navigation: nest related APIs under parent groups - Ensure consistent "Work Item" terminology across all docs * review fixes * coderabbit fixes --------- Co-authored-by: danciaclara <[email protected]>
1 parent 8139982 commit b793a98

File tree

193 files changed

+4406
-1187
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

193 files changed

+4406
-1187
lines changed

‎api-reference/customer/add-customer-property.mdx‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Create a customer property
3+
description: Creates a new customer property definition in a workspace.
4+
api: POST /api/v1/workspaces/{workspace_slug}/customer-properties/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
## Body parameters
14+
15+
<ParamField body="name" type="string">
16+
Name of the property.
17+
</ParamField>
18+
19+
<ParamField body="display_name" type="string">
20+
Display name of the property.
21+
</ParamField>
22+
23+
<ParamField body="description" type="string">
24+
Description of the property.
25+
</ParamField>
26+
27+
<ParamField body="property_type" type="string">
28+
Type of the property.
29+
</ParamField>
30+
31+
<ParamField body="relation_type" type="string">
32+
Relation type of the property.
33+
</ParamField>
34+
35+
<ParamField body="is_required" type="boolean">
36+
Whether the property is required.
37+
</ParamField>
38+
39+
<ParamField body="is_multi" type="boolean">
40+
Whether the property supports multiple values.
41+
</ParamField>
42+
43+
<ParamField body="is_active" type="boolean">
44+
Whether the property is active.
45+
</ParamField>
46+
47+
<ParamField body="sort_order" type="number">
48+
Sort order for the property.
49+
</ParamField>
50+
51+
<ParamField body="default_value" type="string[]">
52+
Default values for the property.
53+
</ParamField>
54+
55+
<ParamField body="settings" type="object">
56+
Settings for the property.
57+
</ParamField>
58+
59+
<ParamField body="validation_rules" type="object">
60+
Validation rules for the property.
61+
</ParamField>
62+
63+
<ParamField body="logo_props" type="object">
64+
Logo properties for the property.
65+
</ParamField>
66+
67+
<ParamField body="external_source" type="string">
68+
External source identifier.
69+
</ParamField>
70+
71+
<ParamField body="external_id" type="string">
72+
External ID from the external source.
73+
</ParamField>
74+

‎api-reference/customer/add-customer-request.mdx‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Create a customer request
3+
description: Creates a new request for a customer.
4+
api: POST /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
16+
17+
## Body parameters
18+
19+
<ParamField body="title" type="string">
20+
Title of the request.
21+
</ParamField>
22+
23+
<ParamField body="description" type="string">
24+
Description of the request.
25+
</ParamField>
26+

‎api-reference/customer/add-customer.mdx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Create a customer
3+
description: Creates a new customer in a workspace.
4+
api: POST /api/v1/workspaces/{workspace_slug}/customers/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
## Body parameters
14+
15+
<ParamField body="name" type="string">
16+
Name of the customer.
17+
</ParamField>
18+
19+
<ParamField body="email" type="string">
20+
Email address of the customer.
21+
</ParamField>
22+

‎api-reference/customer/delete-customer-property.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Delete a customer property
3+
description: Permanently deletes a customer property definition from a workspace. This action cannot be undone.
4+
api: DELETE /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
<ParamField path="property_id" type="string" required>
14+
The unique identifier for the customer property.
15+
</ParamField>
16+

‎api-reference/customer/delete-customer-request.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Delete a customer request
3+
description: Permanently deletes a customer request. This action cannot be undone.
4+
api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
16+
17+
<ParamField path="request_id" type="string" required>
18+
The unique identifier for the request.
19+
</ParamField>
20+

‎api-reference/customer/delete-customer.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Delete a customer
3+
description: Permanently deletes a customer from a workspace. This action cannot be undone.
4+
api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
16+

‎api-reference/customer/get-customer-detail.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Retrieve a customer
3+
description: Retrieves the details of an existing customer by its ID.
4+
api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
16+

‎api-reference/customer/get-customer-property-detail.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Retrieve a customer property
3+
description: Retrieves the details of an existing customer property definition by its ID.
4+
api: GET /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
<ParamField path="property_id" type="string" required>
14+
The unique identifier for the customer property.
15+
</ParamField>
16+

‎api-reference/customer/get-customer-property-value.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Retrieve a customer property value
3+
description: Retrieves a specific property value for a customer by property ID.
4+
api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/property-values/{property_id}/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
16+
17+
<ParamField path="property_id" type="string" required>
18+
The unique identifier for the customer property.
19+
</ParamField>
20+

‎api-reference/customer/get-customer-request-detail.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Retrieve a customer request
3+
description: Retrieves the details of an existing customer request by its ID.
4+
api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/
5+
---
6+
7+
## Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required>
10+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
11+
</ParamField>
12+
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
16+
17+
<ParamField path="request_id" type="string" required>
18+
The unique identifier for the request.
19+
</ParamField>
20+

0 commit comments

Comments
 (0)