Customers overview

Customers are the workspace CRM records you attach requests and work items to.

The customer object

Attributes

• archived_at string (date-time)

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

• contract_status string

  Current contract state, in your own vocabulary.

• created_at string (date-time)

  When the record was created.

• created_by_id string (uuid)

  The user who created the record.

• customer_request_count integer

  How many customer requests are attached.

• description string

  Free-form description.

• description_html string

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

• domain string

  The customer's primary domain, for example example.com.

• email string (email)

  Email address.

• employees integer

  Headcount, for segmentation.

• external_id string

  Your system's identifier for this record, for sync and import correlation.

• external_source string

  The system external_id came from, for example github or jira.

• id string (uuid)

  Unique identifier.

• logo_asset_id string (uuid)

  The related logo asset.

• logo_props string

  Editor-owned logo descriptor. Pass back what you read rather than composing it by hand.

• logo_url string

  URL of the logo image.

• name string

  Display name.

• revenue string

  Annual revenue, for segmentation.

• stage string

  Where the customer sits in your funnel.

• website_url string (uri)

  Public website URL.

Response200

{
  "archived_at": null,
  "contract_status": "active",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "customer_request_count": 3,
  "description": "What this is for.",
  "description_html": "<p>Details go here.</p>",
  "domain": "example.com",
  "email": "ana@example.com",
  "employees": 250,
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "logo_asset_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "logo_props": null,
  "logo_url": "https://example.com/logo.png",
  "name": "Example name",
  "revenue": "4.2M",
  "stage": "customer",
  "website_url": "https://example.com"
}

Endpoints

Method	Path	Description
GET	/api/v2/workspaces/{slug}/customers/	List customers
GET	/api/v2/workspaces/{slug}/customers/{pk}/	Get a customer
POST	/api/v2/workspaces/{slug}/customers/	Create a customer
PATCH	/api/v2/workspaces/{slug}/customers/{pk}/	Update a customer
DELETE	/api/v2/workspaces/{slug}/customers/{pk}/	Delete a customer
POST	/api/v2/workspaces/{slug}/customers/upsert/	Upsert a customer
POST	/api/v2/workspaces/{slug}/customers/{pk}/work-items/	Link or unlink customer work items

Response shaping

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