Skip to main content
GET
List and search patent families

Authorizations

Authorization
string
header
required

Use a personal or organization Pav API key from Pav developer settings. Send it as Authorization: Bearer <api_key>.

Query Parameters

q
string | null

Substring of the title, an owner name, or a member's patent number.

Example:

"GLP-1"

company_id
integer[] | null

Families owned by any of these Pav company ids. Repeatable.

cpc
string | null

CPC classification prefix on any member, e.g. A61K or C07K.

Maximum string length: 16
Example:

"A61K"

state
enum<string> | null

live (a member pending or in force) or lapsed (none).

Available options:
live,
lapsed
granted
boolean | null

true: at least one granted patent; false: none granted.

priority_from
string<date> | null

Earliest priority date on or after (inclusive).

priority_to
string<date> | null

Earliest priority date on or before (inclusive).

include_members
boolean
default:false

Include up to 30 member applications per family.

sort
enum<string>
default:latest_status_date

latest_status_date (default), earliest_priority_date, or member_count; newest or largest first.

Available options:
latest_status_date,
earliest_priority_date,
member_count
limit
integer
default:25

Rows per page (1-100).

Required range: 1 <= x <= 100
offset
integer
default:0

Zero-based row offset for paging.

Required range: 0 <= x <= 10000
include_total
boolean
default:false

Compute the exact total match count.

Response

Successful Response

data
PatentFamily · object[]
required

Page of patent families.

pagination
Pagination · object
required

Pagination metadata for this page.