Customer requests overview

Customer requests capture what a customer asked for, and link that ask to work items.

The customer request object

Attributes

• archived_at string (date-time)

  When the record was archived, or null if it is active.

• created_at string (date-time)

  When the customer request was created.

• updated_at string (date-time)

  When the customer request was last updated.

• created_by_id string (uuid)

  The user who created the customer request.

• updated_by_id string (uuid) or null

  The user who last updated the customer request. null until someone updates it.

• customer_id string (uuid)

  The related customer.

• description string

  Free-form description.

• description_html string

  Rich-text body as HTML. This is the field the Plane editor round-trips.

• id string (uuid)

  Unique identifier.

• link string (uri)

  The link.

• name string

  Display name.

• work_item_ids array of string (uuid)

  Ids of the work items linked through this request. Only work items you can see are listed, and archived work items are left out. Set the links with work_item_ids on Create a customer request or Update a customer request. To read the work items themselves, pass this request's id as customer_request_id to List a customer's work items.

Response200

{
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "customer_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
  "name": "Example name",
  "description": "What this is for.",
  "description_html": "<p>Details go here.</p>",
  "link": "https://example.com",
  "work_item_ids": ["8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13"],
  "archived_at": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": null
}

Endpoints

Method	Path	Description
GET	/api/v2/workspaces/{slug}/customers/{customer_id}/requests/	List customer requests
GET	/api/v2/workspaces/{slug}/customers/{customer_id}/requests/{pk}/	Get a customer request
POST	/api/v2/workspaces/{slug}/customers/{customer_id}/requests/	Create a customer request
PATCH	/api/v2/workspaces/{slug}/customers/{customer_id}/requests/{pk}/	Update a customer request
DELETE	/api/v2/workspaces/{slug}/customers/{customer_id}/requests/{pk}/	Delete a customer request

Response shaping

Every customer request read accepts ?fields= for sparse responses. See Sparse fields. Errors follow the shared problem+json contract.