Share via

US Patent & Trademark Office (Independent Publisher) (Preview)

Search and retrieve bibliographic data for patent applications.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name United States Patent and Trademark Office
URL https://developer.uspto.gov
Email uspto@uspto.gov
Connector Metadata
Publisher krautrocker
Website https://developer.uspto.gov
Privacy policy https://www.uspto.gov/privacy-policy
Categories IT Operations

U.S. Patent and Trademark Office (Independent Publisher)

Publisher: Dan Romano (swolcat)

Prerequisites

You must have a registered developer account with the U.S. Patent and Trademark Office to obtain an API key.

You can sign up and retrieve your key from the USPTO API Developer Hub.

Supported Operations

The connector provides access to USPTO’s patent bibliographic and file wrapper data services.
It supports both query parameter (GET) and structured JSON payload (POST) searches for flexible, high-volume patent data retrieval.

  • GET /applications/search - Search for patent applications using query parameters (q, filters, rangeFilters, sort, etc.).
    Returns the top 25 records by default when no parameters are specified.

  • POST /applications/search- Perform an advanced search using a structured JSON payload with filters, range filters, pagination, and field selection.
    Example:

  • GET /applications/search/download - Retrieve search results in download format using query parameters.

  • POST /applications/search/download - Download the search results in json or csv format using a similar payload as the search POST endpoint.

Patent Application Details

Each of the following endpoints retrieves specific data associated with a given patent application number ({applicationNumberText}):

  • GET /{applicationNumberText} - Get patent by application number

  • GET /{applicationNumberText}/meta-data – Bibliographic metadata for a patent application.

  • GET /{applicationNumberText}/adjustment – Term adjustment information.

  • GET /{applicationNumberText}/assignment – Assignment and ownership data.

  • GET /{applicationNumberText}/attorney – Attorney and correspondence details.

  • GET /{applicationNumberText}/continuity – Continuity data (parent and child applications).

  • GET /{applicationNumberText}/foreign-priority – Foreign priority claim details.

  • GET /{applicationNumberText}/transactions – Application transaction history.

  • GET /{applicationNumberText}/documents – Published file wrapper documents.

  • GET /{applicationNumberText}/associated-documents – Related publication (PGPub or grant) metadata.

Patent Reference Data

  • GET /patent/status-codes – Retrieve status codes and their definitions used in USPTO records.

  • POST /patent/status-codes – Search patent application status codes via JSON payload.

  • GET /datasets/products/search – Search for USPTO product datasets.

  • GET /datasets/products/{productIdentifier} – Retrieve metadata for a specific dataset.

Petition Decision Data

  • GET /petition/decisions/search – Search petition decision records (query parameters).

  • POST /petition/decisions/search – Search petition decision records (JSON).

  • GET /petition/decisions/search/download – Download petition decisions (query parameters).

  • POST /petition/decisions/search/download – Download petition decisions (JSON).

  • GET /petition/decisions/{petitionDecisionRecordIdentifier} – Retrieve a specific petition decision record.

Text-to-Search

  • POST /patent/applications/text-to-search – Accept text input and return matching patent application results.

Obtaining Credentials

  • Official USPTO API Reference can be found here.

Getting Started

Official site

Official USPTO API Reference

  • Navigate to the USPTO Developer Hub.
  • Register or log in to your developer account.
  • Request an API key for the Patent Data APIs.Note: API Key is required. Obtain an API key here.
  • Copy your API key and store it securely. You will use it to authenticate requests.

When creating the connection in Power Platform, enter your USPTO API Key. The connector automatically sends this key in the request header as x-api-key: {your-api-key}

Known Issues and Limitations

1.) Request limitations

The USPTO may rate-limit API usage depending on request volume.

  • The /search/download GET endpoint may not be available in sandbox mode; use the POST variant instead.

  • Query timeouts may occur when using complex filters or large date ranges.

  • Data freshness depends on USPTO’s internal publication schedule.

2.) Transitioning

  • From the website: "As of March 14, 2025, Patent Examination Data System (PEDS) is no longer available. To access publicly available records of USPTO patent applications or patent filing status, users can access Open Data Portal’s Patent File Wrapper feature."

  • [Read more here[(https://data.uspto.gov/apis/transition-guide/bdss).

3.) Text-to-Search endpoint

The Text-to-Search endpoint can be found in the Swagger doc, but it is not listed in the public site. That endpoint is not included in this connector.

Consider using /api/v1/patent/applications/search as an alternative.

4.) Product identifier codes

For bulk data endpoints, a product identifier is required. Examples can be found here.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
api_key securestring The api_key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Download patent data

Download patent application data by supplying JSON search payload.
Download petition decision data (advanced JSON)

Download petition decision data by supplying a structured JSON payload. The response supports JSON or CSV format, based on the format parameter.
Download petition decision data (query parameters)

Retrieve petition decision data by supplying query parameters. Supports optional query parameters and returns the top 25 results by default.
Get associated publication and grant document metadata

Retrieve metadata for associated publication (PGPub) and grant documents linked to a specific patent application number.
Get attorney or agent data

Retrieve attorney or agent representation details for a specific patent application number.
Get bulk dataset product by identifier

Retrieve details for a specific USPTO bulk dataset product by its short name (productIdentifier). Optional parameters allow filtering by date range and inclusion of product files.
Get document metadata for a patent application

Retrieve details of documents filed or issued for a specific patent application number, including office actions, responses, and fee worksheets.
Get foreign priority data

Retrieve foreign priority details for a specific patent application, including foreign filing numbers, countries, and filing dates.
Get patent application by number

Retrieve detailed bibliographic data for a specified patent application number. Application numbers containing special characters (e.g. PCT/BR00/000001) must be UTF-8 encoded.
Get patent application metadata

Retrieve metadata details for a specified patent application number, including bibliographic and file wrapper data.
Get patent assignment data

Retrieve assignment and ownership transfer information for a specific patent application number.
Get patent continuity data

Retrieve parent and child continuity relationships for a specified patent application number, including continuations, divisionals, and continuations-in-part.
Get patent term adjustment data

Retrieve patent term adjustment details for a specific application number, including extensions and delay information.
Get patent transaction history

Retrieve a chronological list of prosecution events and transactions for a specific patent application number.
Get petition decision by identifier

Retrieve detailed petition decision information by its unique petition decision record identifier. Optionally include decision documents in the response using the includeDocuments query parameter.
Retrieve patent application status codes

Search and filter patent application status codes and descriptions using query parameters. All parameters are optional. Returns top 25 results by default.
Search bulk dataset products

Retrieve available USPTO bulk datasets with optional filters and search parameters.
Search patent application status codes via JSON payload

Perform advanced search for patent application status codes using a structured JSON payload. All fields in the request are optional.
Search patent applications (advanced JSON)

Retrieve patent application data using structured JSON payload.
Search patent applications using query parameters

Returns up to 25 patent applications matching optional filters, fields, sort, and facets.
Search petition decisions (advanced JSON)

Retrieve petition decision data using a structured JSON payload. Supports Boolean search, filters, range filters, sorting, field selection, and pagination.
Search petition decisions (query parameters)

Retrieve petition decision data by providing query parameters. Query parameters are optional—if none are supplied, the top 25 records are returned.

Download patent data

Operation ID:
Download_Patent_Search_Results

Download patent application data by supplying JSON search payload.

Parameters

Name Key Required Type Description
q
 q string

Search query string.
name
 name string
value
 value array of string
field
 field string
valueFrom
 valueFrom string
valueTo
 valueTo string
field
 field string
order
 order string
fields
 fields array of string
offset
 offset integer
limit
 limit integer
format
 format string

Returns

Body
PatentDataResponse

Download petition decision data (advanced JSON)

Operation ID:
Download_Petition_Decisions_POST

Download petition decision data by supplying a structured JSON payload. The response supports JSON or CSV format, based on the format parameter.

Parameters

Name Key Required Type Description
q
 q string

Query string with Boolean or field-based search.
name
 name string
value
 value array of string
field
 field string
valueFrom
 valueFrom string
valueTo
 valueTo string
field
 field string
order
 order string
fields
 fields array of string

Fields to include in the output.
offset
 offset integer
limit
 limit integer
facets
 facets array of string

Optional facets to compute aggregations.
format
 format string

Format of the returned data.

Returns

Petition decision search response.

Body
PetitionDecisionResponseBag

Download petition decision data (query parameters)

Operation ID:
Download_Petition_Decisions_GET

Retrieve petition decision data by supplying query parameters. Supports optional query parameters and returns the top 25 results by default.

Parameters

Name Key Required Type Description
Search query
 q string

A search query string that accepts Boolean operators (AND, OR, NOT), wildcards (*), and exact phrases ("").
Sort order
 sort string

Field name followed by sort order (asc or desc).
Offset
 offset integer

Dataset position to begin the response from.
Limit
 limit integer

Maximum number of records to return.
Selected fields
 fields string

Comma-separated list of fields to include in the result.
Filters
 filters string

Filter the results by field name and value. Example: decisionTypeCodeDescriptionText DENIED
Range filters
 rangeFilters string

Filter by numeric or date ranges. Example: petitionMailDate 2021-01-01:2025-01-01
Download format
 format string

Format of the returned dataset (json or csv).

Returns

Petition decision search response.

Body
PetitionDecisionResponseBag

Get associated publication and grant document metadata

Operation ID:
Get_Patent_Application_AssociatedDocuments

Retrieve metadata for associated publication (PGPub) and grant documents linked to a specific patent application number.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which associated publication and grant documents are requested.

Returns

Body
PatentAssociatedDocumentsResponse

Get attorney or agent data

Operation ID:
Get_Patent_Application_Attorney

Retrieve attorney or agent representation details for a specific patent application number.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which attorney or agent information is requested.

Returns

Body
PatentAttorneyResponse

Get bulk dataset product by identifier

Operation ID:
Get_Bulk_DataSet_Product

Retrieve details for a specific USPTO bulk dataset product by its short name (productIdentifier). Optional parameters allow filtering by date range and inclusion of product files.

Parameters

Name Key Required Type Description
Product identifier
 productIdentifier True string

Short name of the bulk dataset product (e.g. BDSS_PETITIONS_2024).
File data start date
 fileDataFromDate date

Start date (inclusive) to filter dataset files by date.
File data end date
 fileDataToDate date

End date (inclusive) to filter dataset files by date.
Offset
 offset integer

Number of product file records to skip.
Limit
 limit integer

Number of product file records to return.
Include files
 includeFiles boolean

Set to true to include detailed file records in the response; false to omit them.
Latest only
 latest boolean

Set to true to return only the latest product file for this dataset.

Returns

Detailed response for a specific USPTO bulk dataset product.

Body
BdssResponseProductBag

Get document metadata for a patent application

Operation ID:
Get_Patent_Application_Documents

Retrieve details of documents filed or issued for a specific patent application number, including office actions, responses, and fee worksheets.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which document details are requested.
Document codes
 documentCodes string

Comma-separated list of document codes to filter results.
From date
 officialDateFrom date

Start of date range for document official date (yyyy-MM-dd).
To date
 officialDateTo date

End of date range for document official date (yyyy-MM-dd).

Returns

Body
PatentDocumentResponse

Get foreign priority data

Operation ID:
Get_Patent_Application_ForeignPriority

Retrieve foreign priority details for a specific patent application, including foreign filing numbers, countries, and filing dates.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which foreign priority data is requested.

Returns

Body
PatentForeignPriorityResponse

Get patent application by number

Operation ID:
Get_Patent_Application_By_Number

Retrieve detailed bibliographic data for a specified patent application number. Application numbers containing special characters (e.g. PCT/BR00/000001) must be UTF-8 encoded.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number (UTF-8 encoded if special characters present).

Returns

Body
PatentDataResponse

Get patent application metadata

Operation ID:
Get_Patent_Application_MetaData

Retrieve metadata details for a specified patent application number, including bibliographic and file wrapper data.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which metadata is requested.

Returns

Body
ApplicationMetaDataResponse

Get patent assignment data

Operation ID:
Get_Patent_Application_Assignment

Retrieve assignment and ownership transfer information for a specific patent application number.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which assignment information is requested.

Returns

Body
PatentAssignmentResponse

Get patent continuity data

Operation ID:
Get_Patent_Application_Continuity

Retrieve parent and child continuity relationships for a specified patent application number, including continuations, divisionals, and continuations-in-part.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which continuity data is requested.

Returns

Body
PatentContinuityResponse

Get patent term adjustment data

Operation ID:
Get_Patent_Application_Adjustment

Retrieve patent term adjustment details for a specific application number, including extensions and delay information.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which term adjustment information is requested.

Returns

Body
PatentAdjustmentResponse

Get patent transaction history

Operation ID:
Get_Patent_Application_Transactions

Retrieve a chronological list of prosecution events and transactions for a specific patent application number.

Parameters

Name Key Required Type Description
Application number
 applicationNumberText True string

Patent application number for which transaction history is requested.

Returns

Body
PatentTransactionResponse

Get petition decision by identifier

Operation ID:
Get_Petition_Decision_By_Id

Retrieve detailed petition decision information by its unique petition decision record identifier. Optionally include decision documents in the response using the includeDocuments query parameter.

Parameters

Name Key Required Type Description
Petition Decision Identifier
 petitionDecisionRecordIdentifier True string

Unique petition decision record identifier.
Include decision documents
 includeDocuments boolean

Set to true to include petition decision documents in the response, or false to omit them.

Returns

Response object containing petition decision details for a specific identifier.

Body
PetitionDecisionIdentifierResponseBag

Retrieve patent application status codes

Operation ID:
Get_Patent_Status_Codes

Search and filter patent application status codes and descriptions using query parameters. All parameters are optional. Returns top 25 results by default.

Parameters

Name Key Required Type Description
Search query
 q string

A search string supporting boolean operators (AND, OR, NOT), wildcards (*), and exact phrases ("").
Result offset
 offset integer

Position in the dataset of a particular record.
Result limit
 limit integer

Limit the number of results returned.

Returns

Response structure for patent status code search results.

Body
StatusCodeSearchResponse

Search bulk dataset products

Operation ID:
Search_Bulk_DataSets

Retrieve available USPTO bulk datasets with optional filters and search parameters.

Parameters

Name Key Required Type Description
Search query
 q string

A search query string supporting boolean operators (AND, OR, NOT), wildcards (*), and exact phrases (""). Example: decisionTypeCodeDescriptionText:Denied OR finalDecidingOfficeName:OFFICE
Sort field
 sort string

Field to sort results by (e.g., petitionMailDate asc).
Record offset
 offset integer

Position in the dataset of the first record to return.
Result limit
 limit integer

Maximum number of results to return.
Facets
 facets string

Comma-separated list of fields to group (facet) results by.
Fields
 fields string

Comma-separated list of fields to include in the response.
Filters
 filters string

Field-value filters separated by space. Example: technologyCenter 3600 or businessEntityStatusCategory 'Small'.
Range filters
 rangeFilters string

Specify numeric or date range filters using : separator. Example: petitionMailDate 2021-01-01:2025-01-01

Returns

Response structure for USPTO Bulk DataSet Search results.

Body
BdssResponseBag

Search patent application status codes via JSON payload

Operation ID:
Search_Patent_Status_Codes_POST

Perform advanced search for patent application status codes using a structured JSON payload. All fields in the request are optional.

Parameters

Name Key Required Type Description
q
 q string

Search query supporting boolean operators (AND, OR, NOT), wildcards (*), and exact phrases (""). Matches across status code and description fields.
name
 name string

Field name to filter by.
value
 value array of string

List of filter values for the specified field.
field
 field string

Field name for the range filter.
valueFrom
 valueFrom string

Starting value of the range (inclusive).
valueTo
 valueTo string

Ending value of the range (inclusive).
field
 field string

Field name to sort by.
order
 order string

Sort order (asc or desc).
offset
 offset integer

Offset of the first record to return.
limit
 limit integer

Maximum number of records to return.

Returns

Response structure for patent status code search results.

Body
StatusCodeSearchResponse

Search patent applications (advanced JSON)

Operation ID:
Search_Patent_Applications_POST

Retrieve patent application data using structured JSON payload.

Parameters

Name Key Required Type Description
q
 q string

Search query string supporting boolean operators and wildcards.
name
 name string
value
 value array of string
field
 field string
valueFrom
 valueFrom string
valueTo
 valueTo string
field
 field string
order
 order string
fields
 fields array of string
offset
 offset integer
limit
 limit integer
facets
 facets array of string

Returns

Body
PatentDataResponse

Search patent applications using query parameters

Operation ID:
Search_Patent_Applications_GET

Returns up to 25 patent applications matching optional filters, fields, sort, and facets.

Parameters

Name Key Required Type Description
Search query
 q string

Search text string supporting Boolean, range, and wildcard syntax.
Sort order
 sort string

Field and sort order (e.g., filingDate asc).
Offset
 offset integer

Record offset position.
Limit
 limit integer

Number of records to return.
Facets
 facets string

Comma-separated fields to facet upon.
Fields
 fields string

Comma-separated list of fields to include in results.
Filters
 filters string

Filter records by field name and value.
Range filters
 rangeFilters string

Range filters for numeric or date fields.

Returns

Body
PatentDataResponse

Search petition decisions (advanced JSON)

Operation ID:
Search_Petition_Decisions_POST

Retrieve petition decision data using a structured JSON payload. Supports Boolean search, filters, range filters, sorting, field selection, and pagination.

Parameters

Name Key Required Type Description
q
 q string

Search text with Boolean operators or field-based queries.
name
 name string
value
 value array of string
field
 field string
valueFrom
 valueFrom string
valueTo
 valueTo string
field
 field string
order
 order string
fields
 fields array of string

List of fields to include in the response.
offset
 offset integer
limit
 limit integer
facets
 facets array of string

List of field names to generate facets for.

Returns

Petition decision search response.

Body
PetitionDecisionResponseBag

Search petition decisions (query parameters)

Operation ID:
Search_Petition_Decisions_GET

Retrieve petition decision data by providing query parameters. Query parameters are optional—if none are supplied, the top 25 records are returned.

Parameters

Name Key Required Type Description
Search query
 q string

Query string supporting Boolean operators (AND, OR, NOT), wildcards (*), and exact phrases ("").
Sort order
 sort string

Field name followed by sort direction (asc or desc).
Offset
 offset integer

Position in the dataset of the first record to return.
Limit
 limit integer

Maximum number of records to return.
Facet fields
 facets string

Comma-separated list of fields to facet upon.
Selected fields
 fields string

Comma-separated list of fields to include in the response.
Filters
 filters string

Filter results by supplying a field name and value.
Range filters
 rangeFilters string

Filter results by providing numeric or date ranges.

Returns

Petition decision search response.

Body
PetitionDecisionResponseBag

Definitions

PatentDataResponse

Name Path Type Description
totalCount
 totalCount integer
response
 response array of object
applicationNumberText
 response.applicationNumberText string
filingDate
 response.filingDate date
publicationNumber
 response.publicationNumber string
inventorName
 response.inventorName string
assigneeName
 response.assigneeName string
applicationType
 response.applicationType string

ApplicationMetaDataResponse

Name Path Type Description
count
 count integer
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object
applicationNumberText
 patentFileWrapperDataBag.applicationNumberText string

Free format of the application number
applicationMetaData
 patentFileWrapperDataBag.applicationMetaData ApplicationMetaData
requestIdentifier
 requestIdentifier string

ApplicationMetaData

Name Path Type Description
filingDate
 filingDate string
applicationTypeCode
 applicationTypeCode string
applicationStatusCode
 applicationStatusCode integer
firstApplicantName
 firstApplicantName string
firstInventorToFileIndicator
 firstInventorToFileIndicator string
entityStatus
 entityStatus string
groupArtUnitNumber
 groupArtUnitNumber string
docketNumber
 docketNumber string
publicationCategoryBag
 publicationCategoryBag array of string
examinerName
 examinerName string
patentNumber
 patentNumber string

PatentAdjustmentResponse

Name Path Type Description
count
 count integer
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object
applicationNumberText
 patentFileWrapperDataBag.applicationNumberText string

Free format of application number
patentTermAdjustmentData
 patentFileWrapperDataBag.patentTermAdjustmentData PatentTermAdjustment
requestIdentifier
 requestIdentifier string

PatentTermAdjustment

Name Path Type Description
applicationNumberText
 applicationNumberText string
totalDays
 totalDays integer

Total patent term adjustment days granted
aDelayDays
 aDelayDays integer

Number of days delayed under USPTO A delay category
bDelayDays
 bDelayDays integer

Number of days delayed under USPTO B delay category
cDelayDays
 cDelayDays integer

Number of days delayed under USPTO C delay category
overlapDays
 overlapDays integer

Days overlapping between categories, subtracted from total
issueDate
 issueDate date
publicationDate
 publicationDate date
calculationDate
 calculationDate date
status
 status string

Current status of patent term adjustment calculation

PatentAssignmentResponse

Name Path Type Description
count
 count integer
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object
applicationNumberText
 patentFileWrapperDataBag.applicationNumberText string

Free format of application number
assignmentBag
 patentFileWrapperDataBag.assignmentBag array of Assignment
requestIdentifier
 requestIdentifier string

Assignment

Name Path Type Description
reelNumber
 reelNumber integer

Reel number identifying the recorded assignment
frameNumber
 frameNumber integer

Frame number within the reel
recordedDate
 recordedDate date

Date assignment was recorded
executionDate
 executionDate date

Date assignment was executed
conveyanceText
 conveyanceText string

Type of conveyance or assignment
assignorName
 assignorName string

Name of assignor
assigneeName
 assigneeName string

Name of assignee
correspondenceAddress
 correspondenceAddress string

Correspondence address associated with assignment
documentIdentifier
 documentIdentifier string

Concatenated reel and frame identifier
publicationDate
 publicationDate date

Date assignment data was published

PatentAttorneyResponse

Name Path Type Description
count
 count integer
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object
applicationNumberText
 patentFileWrapperDataBag.applicationNumberText string

Free format of application number
recordAttorney
 patentFileWrapperDataBag.recordAttorney RecordAttorney
requestIdentifier
 requestIdentifier string

RecordAttorney

Name Path Type Description
attorneyDocketNumber
 attorneyDocketNumber string

Attorney docket number associated with the application
attorneyName
 attorneyName string

Name of the attorney of record
registrationNumber
 registrationNumber string

USPTO registration number for the attorney or agent
lawFirmName
 lawFirmName string

Law firm or organization representing the applicant
correspondenceAddress
 correspondenceAddress string

Correspondence address on record
phoneNumber
 phoneNumber string

Phone number for correspondence
emailAddress
 emailAddress string

Contact email for attorney or agent
effectiveDate
 effectiveDate date

Effective date for attorney of record entry
status
 status string

Current status of attorney or agent record

PatentContinuityResponse

Name Path Type Description
count
 count integer
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object
applicationNumberText
 patentFileWrapperDataBag.applicationNumberText string

Free format of application number
parentContinuityBag
 patentFileWrapperDataBag.parentContinuityBag array of ParentContinuityData
childContinuityBag
 patentFileWrapperDataBag.childContinuityBag array of ChildContinuityData
requestIdentifier
 requestIdentifier string

ParentContinuityData

Name Path Type Description
parentApplicationNumberText
 parentApplicationNumberText string

Parent application number
relationType
 relationType string

Type of parent relationship
filingDate
 filingDate date
patentNumber
 patentNumber string
publicationNumber
 publicationNumber string
issueDate
 issueDate date

ChildContinuityData

Name Path Type Description
childApplicationNumberText
 childApplicationNumberText string

Child application number
relationType
 relationType string

Type of child relationship
filingDate
 filingDate date
patentNumber
 patentNumber string
publicationNumber
 publicationNumber string
issueDate
 issueDate date

PatentForeignPriorityResponse

Name Path Type Description
count
 count integer
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object
applicationNumberText
 patentFileWrapperDataBag.applicationNumberText string

Free format of application number
foreignPriorityBag
 patentFileWrapperDataBag.foreignPriorityBag array of ForeignPriority
requestIdentifier
 requestIdentifier string

ForeignPriority

Name Path Type Description
foreignApplicationNumberText
 foreignApplicationNumberText string

Foreign priority application number
foreignFilingDate
 foreignFilingDate date

Date of foreign priority filing
foreignCountryCode
 foreignCountryCode string

Two-letter ISO country code for foreign filing
foreignCountryName
 foreignCountryName string

Name of the foreign country
foreignPatentOffice
 foreignPatentOffice string

Foreign patent office identifier
kindCode
 kindCode string

Kind code for foreign publication
relationType
 relationType string

Relationship type (e.g., Priority, Parent)
internationalFilingIndicator
 internationalFilingIndicator string

Indicates if the filing was international (PCT)
translationRequired
 translationRequired boolean

Indicates whether a translation is required

PatentTransactionResponse

Name Path Type Description
count
 count integer
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object
applicationNumberText
 patentFileWrapperDataBag.applicationNumberText string

Free format of application number
eventDataBag
 patentFileWrapperDataBag.eventDataBag array of EventData
requestIdentifier
 requestIdentifier string

EventData

Name Path Type Description
eventCode
 eventCode string

Code or label for the prosecution event
eventDescription
 eventDescription string

Text description of the event
eventDate
 eventDate string

Date when the event occurred
eventCategory
 eventCategory string

Category of event
documentCode
 documentCode string

Code identifying related document
documentName
 documentName string

Name of the related document
correspondentName
 correspondentName string

Correspondent associated with event
transactionId
 transactionId string

Unique identifier for transaction
fileSize
 fileSize integer

File size in bytes of associated document, if any
downloadUrl
 downloadUrl string

URL to download associated document

PatentDocumentResponse

Name Path Type Description
count
 count integer
documents
 documents array of DocumentBag
requestIdentifier
 requestIdentifier string

DocumentBag

Name Path Type Description
documentCode
 documentCode string

Code identifying the type of document
documentDescription
 documentDescription string

Description of the document type
documentCategory
 documentCategory string

Category of document (Incoming/Outgoing)
officialDate
 officialDate date

Official date associated with the document
createDate
 createDate date

Date document was created in system
fileSize
 fileSize integer

File size of the document in bytes
documentUrl
 documentUrl string

URL for retrieving or downloading the document
documentPageCount
 documentPageCount integer

Number of pages in the document
submitterName
 submitterName string

Name of the submitting party
examinerName
 examinerName string

Examiner associated with the document
artUnit
 artUnit string

Art unit responsible for the document

PatentAssociatedDocumentsResponse

Name Path Type Description
count
 count integer
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object
applicationNumberText
 patentFileWrapperDataBag.applicationNumberText string

Free format of application number
pgpubDocumentMetaData
 patentFileWrapperDataBag.pgpubDocumentMetaData PGPubFileMetaData
grantDocumentMetaData
 patentFileWrapperDataBag.grantDocumentMetaData GrantFileMetaData
requestIdentifier
 requestIdentifier string

PGPubFileMetaData

Name Path Type Description
publicationNumber
 publicationNumber string

Publication number for the pre-grant publication
publicationDate
 publicationDate date

Date of the pre-grant publication
kindCode
 kindCode string

Kind code for publication
title
 title string

Title of the publication
applicantName
 applicantName string

Applicant or assignee listed on publication
documentUrl
 documentUrl string

URL to retrieve publication document

GrantFileMetaData

Name Path Type Description
patentNumber
 patentNumber string

Granted patent number
grantDate
 grantDate date

Date the patent was granted
kindCode
 kindCode string

Kind code for granted patent
title
 title string

Title of the granted patent
assigneeName
 assigneeName string

Assignee listed on grant
issueClassification
 issueClassification string

Primary classification of granted patent
documentUrl
 documentUrl string

URL to retrieve the granted patent document

StatusCodeSearchResponse

Response structure for patent status code search results.

Name Path Type Description
count
 count integer

Number of status codes returned.
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object

Array of patent status code records.
applicationStatusCode
 patentFileWrapperDataBag.applicationStatusCode integer

Unique numeric or alphanumeric status code.
applicationStatusDescriptionText
 patentFileWrapperDataBag.applicationStatusDescriptionText string

Description of the application status.
statusCategoryName
 patentFileWrapperDataBag.statusCategoryName string

Status category grouping, if available.
statusEffectiveDate
 patentFileWrapperDataBag.statusEffectiveDate date

Effective date of this status code.
statusTerminationIndicator
 patentFileWrapperDataBag.statusTerminationIndicator boolean

Indicates whether the status represents termination of prosecution.
requestIdentifier
 patentFileWrapperDataBag.requestIdentifier string

Unique request identifier for tracing API calls.
requestIdentifier
 requestIdentifier string

Unique ID for the entire API call.

BdssResponseProductBag

Detailed response for a specific USPTO bulk dataset product.

Name Path Type Description
count
 count integer

Number of product file records returned.
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object

Array containing product metadata and optional file details.
productIdentifier
 patentFileWrapperDataBag.productIdentifier string

Unique identifier for the dataset product (short name).
productName
 patentFileWrapperDataBag.productName string

Human-readable name of the product.
productDescription
 patentFileWrapperDataBag.productDescription string

Description of dataset contents.
productVersion
 patentFileWrapperDataBag.productVersion string

Dataset version.
publicationDate
 patentFileWrapperDataBag.publicationDate date

Date of dataset publication.
productType
 patentFileWrapperDataBag.productType string

Dataset file type (e.g., XML, JSON, CSV).
recordCount
 patentFileWrapperDataBag.recordCount integer

Number of records in the dataset.
downloadUrl
 patentFileWrapperDataBag.downloadUrl string

Direct link to download the dataset.
checksum
 patentFileWrapperDataBag.checksum string

File checksum for integrity verification.
includeFiles
 patentFileWrapperDataBag.includeFiles boolean

Whether product files were included in the response.
productFiles
 patentFileWrapperDataBag.productFiles array of object

List of associated dataset files (if included).
fileName
 patentFileWrapperDataBag.productFiles.fileName string

Dataset file name.
fileSize
 patentFileWrapperDataBag.productFiles.fileSize integer

File size in bytes.
fileDataDate
 patentFileWrapperDataBag.productFiles.fileDataDate date

Date associated with the file’s dataset content.
fileUrl
 patentFileWrapperDataBag.productFiles.fileUrl string

Direct link to download the file.
checksum
 patentFileWrapperDataBag.productFiles.checksum string

File checksum for verification.
requestIdentifier
 patentFileWrapperDataBag.requestIdentifier string

Unique request identifier for tracing.

BdssResponseBag

Response structure for USPTO Bulk DataSet Search results.

Name Path Type Description
count
 count integer

Number of dataset products returned.
patentFileWrapperDataBag
 patentFileWrapperDataBag array of object

Array of dataset metadata objects.
productCode
 patentFileWrapperDataBag.productCode string

Unique product or dataset identifier.
productName
 patentFileWrapperDataBag.productName string

Human-readable name of the dataset product.
productDescription
 patentFileWrapperDataBag.productDescription string

Description of the dataset content.
productVersion
 patentFileWrapperDataBag.productVersion string

Dataset version number.
productType
 patentFileWrapperDataBag.productType string

Type of dataset (e.g., XML, JSON, CSV).
publicationDate
 patentFileWrapperDataBag.publicationDate date

Date of dataset publication.
recordCount
 patentFileWrapperDataBag.recordCount integer

Number of records available in the dataset.
downloadUrl
 patentFileWrapperDataBag.downloadUrl string

Direct URL for dataset download.
checksum
 patentFileWrapperDataBag.checksum string

SHA or MD5 checksum for dataset file verification.
requestIdentifier
 patentFileWrapperDataBag.requestIdentifier string

Unique request ID for traceability.
requestIdentifier
 requestIdentifier string

Unique request identifier for the API call.

PetitionDecisionResponseBag

Petition decision search response.

Name Path Type Description
count
 count integer

Number of matching records.
petitionDecisionDataBag
 petitionDecisionDataBag array of object

Array of petition decision records.
petitionDecisionRecordIdentifier
 petitionDecisionDataBag.petitionDecisionRecordIdentifier string

Unique identifier for the petition decision record.
patentNumber
 petitionDecisionDataBag.patentNumber string

Patent number associated with the petition.
firstApplicantName
 petitionDecisionDataBag.firstApplicantName string

Name of the first applicant.
petitionMailDate
 petitionDecisionDataBag.petitionMailDate string

Petition mail date.
decisionTypeCodeDescriptionText
 petitionDecisionDataBag.decisionTypeCodeDescriptionText string

Decision outcome.
decisionMailDate
 petitionDecisionDataBag.decisionMailDate string

Decision mail date.
finalDecidingOfficeName
 petitionDecisionDataBag.finalDecidingOfficeName string

Name of the final deciding office.
decisionDate
 petitionDecisionDataBag.decisionDate string

Decision date.
technologyCenter
 petitionDecisionDataBag.technologyCenter string

Technology center associated with the petition.
facets
 facets object

Faceted field counts.
requestIdentifier
 requestIdentifier string

Unique identifier for the API request.

PetitionDecisionIdentifierResponseBag

Response object containing petition decision details for a specific identifier.

Name Path Type Description
petitionDecisionRecordIdentifier
 petitionDecisionRecordIdentifier string

Unique identifier for the petition decision record.
patentNumber
 patentNumber string

Patent number associated with the petition decision.
firstApplicantName
 firstApplicantName string

Name of the first applicant.
petitionMailDate
 petitionMailDate string

Petition mail date.
decisionDate
 decisionDate string

Date of the decision.
decisionMailDate
 decisionMailDate string

Date the decision was mailed.
decisionTypeCodeDescriptionText
 decisionTypeCodeDescriptionText string

Description of the decision type.
finalDecidingOfficeName
 finalDecidingOfficeName string

Name of the office or division that made the final decision.
petitionDecisionDocuments
 petitionDecisionDocuments array of object

List of decision document metadata (included if includeDocuments=true).
documentName
 petitionDecisionDocuments.documentName string
documentType
 petitionDecisionDocuments.documentType string
documentSize
 petitionDecisionDocuments.documentSize string
documentUrl
 petitionDecisionDocuments.documentUrl string
requestIdentifier
 requestIdentifier string

Unique identifier for the API request.