Skip to content

Intake work items overview ​

Intake work items are the triage queue for a project.

The intake work item object ​

Attributes ​

  • created_at string (date-time)

    When the intake work item was created.

  • updated_at string (date-time)

    When the intake work item was last updated.

  • created_by_id string (uuid)

    The user who created the intake work item.

  • updated_by_id string (uuid) or null

    The user who last updated the intake work item. null until someone updates it.

  • description_html string

    Rich-text body as HTML. The Plane editor reads and writes this field.

  • duplicate_to_id string (uuid)

    id of the work item this one is a duplicate of.

  • 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.

  • intake_id string (uuid)

    id of the intake this item belongs to.

  • name string

    Display name.

  • priority string

    Urgency of the work item.

  • snoozed_till string (date-time)

    The time until which the intake work item is snoozed.

  • source string

    Where the intake work item came from.

  • source_email string

    The source email address.

  • state_id string (uuid)

    id of the state.

  • status integer

    Triage status. One of -2 (pending), -1 (rejected), 0 (snoozed), 1 (accepted), or 2 (duplicate).

  • work_item_id string (uuid)

    id of the linked work item.

Response200
json
{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description_html": "<p>Details go here.</p>",
  "duplicate_to_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "intake_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "name": "Example name",
  "priority": "high",
  "snoozed_till": "2026-01-14T09:22:41.478363Z",
  "source": "example",
  "source_email": "example",
  "state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "status": -2,
  "work_item_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/projects/{project_id}/intake-issues/List intake work items
GET/api/v2/workspaces/{slug}/projects/{project_id}/intake-issues/{pk}/Get an intake work item
POST/api/v2/workspaces/{slug}/projects/{project_id}/intake-issues/Create an intake work item
PATCH/api/v2/workspaces/{slug}/projects/{project_id}/intake-issues/{pk}/Update an intake work item
DELETE/api/v2/workspaces/{slug}/projects/{project_id}/intake-issues/{pk}/Delete an intake work item

Response shaping ​

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