PATENTFAMILY: Patent Family
The PATENTFAMILY entity represents a patent family grouping related patents such as continuations, divisionals, and CIPs sharing a common priority.
Default definition. This article describes the default
PATENTFAMILY definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches PATENTFAMILY.Entity properties
| Property | Value |
|---|---|
| Entity code | PATENTFAMILY |
| Display name | Patent Family |
| Plural | Patent Families |
| Level | 420 |
Use cases
Groups related PATENT records into families. Two-panel layout: General has family details (name, priority date, priority country, priority application number, status) and a relatedlist of PATENT records in the family. Notes panel for family-level commentary. PATENT records link to a family via objectLookup on familyId field.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
ownerId | reference → user | Created by. Read-only. | |
name | text | Yes | Family name. |
priorityDate | date | Priority date. | |
priorityCountry | reference → PATENTJ | Priority country. | |
priorityAppNumber | text | Priority application number. | |
status | enum | Status. Valid ids: active (Active), granted (Fully Granted), mixed (Mixed), expired (Expired). |
Additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
priorityCountrypoints atPATENTJrecord. - Related lists:
PATENTvia formatSUB|PATFAM.
Creating a Patent Family via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "PATENTFAMILY",
"level": 420,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"priorityDate": "2026-01-01",
"priorityCountry": "",
"priorityAppNumber": "Example text"
} Listing PATENTFAMILY records
# All patent families in your tenant
GET /v1/entities/PATENTFAMILY/SUB