Skip to main content
GET
List 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

Free text.

Maximum string length: 300
company_id
string[] | null

Company ids, comma-separated. Includes the companies each one owns.

Example:

"412"

cpc
string | null

CPC prefix on any member (A61K38/26).

Maximum string length: 16
Example:

"A61K"

status
enum<string> | null

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

Available options:
live,
lapsed
granted
boolean | null

Whether at least one member is granted.

from
string<date> | null

On or after this date.

to
string<date> | null

On or before this date.

sort
string | null

One of latest_status_date, earliest_priority_date, member_count; prefix - to descend. Default -latest_status_date.

view
enum<string>
default:full

full (default) or slim for light rows.

Available options:
full,
slim
Example:

"slim"

limit
integer
default:50

Rows per page (1-200).

Required range: 1 <= x <= 200
Example:

50

cursor
string | null

next_cursor from the previous page.

Maximum string length: 2000

Response

Successful Response

data
PatentFamily · object[]
required

Page of patent families.

next_cursor
string | null

Pass as cursor to get the next page. Null on the last page. See Conventions.

Example:

"eyJyIjoicHJvZ3JhbXMiLCJzIjoiY29tcGFueSJ9"

total
integer | null

Rows matching the filters. Null for relevance-ranked q results.

Example:

1284