Return Fields


Return Fields

Return Field values are used in the "returnField" Query Parameter to select the Fields the API should Return in the Response Object.


Field NameDescription
abstractPopulates all abstract paragraphs for all languages
agentPopulates the agent for the publication
allPopulates all the fields on the PatentDocument except for images, uspto_pair, pdf and uspto_ptab
app_pub_referencesPopulates all the application or publication references from all data sources related with the publication
applicantPopulates the applicants for the publication
assigneePopulates the assignees for the publication
assignmentsPopulates the assignments for the publication
citation_countsPopulates the backward and forward citation counts for the publication
citationsPopulates the citations (backward and forward) as well as the (non-Patent Language) NPL Citations for the publication
claimsPopulates the claims (all languages) for the publication, this will populate the claims_xml field as well
claims_xmlPopulates the claimsXml field for the publication
classificationsPopulates the classifications for the publication
correspondentPopulates the correspondent for the publication
corptreePopulates the connected Corporate Tree ktMINE data for the publications' parties (will need to format as - ["corptree", "parties"])
current_assigneePopulates the current assignee of the publication
current_ownerPopulates the current owner of the publication, current owner is distinct from current assignee as there can be a different assignee than owner (e.g. security assignment)
descriptionsPopulates the descriptions (all languages) for the publication
designationsPopulates all the contracting states and designated states in the publication
docdb_familyPopulates all the Simple Family Members for the publication
examinerPopulates the examiner for the publication
expiration_datePopulates the expiration date of the publication
imagesPopulates the relative paths of the images for the publication
inpadoc_familyPopulates the Extended Family Members for the publication
intl_dataPopulates the International Convention Data for the publication if applicable
inventorPopulates the inventors for the publication
ipcPopulates the IPC Classifications for the publication
legal_eventsPopulates the legal events (INPADOC and national office) for the publication
legal_statusPopulates the legal status value for the publication. This will also cause legal events to be populated
partiesPopulates ALL parties for the publication
pdfProvides the relative API url for accessing the original PDF. You will need to append ?key=API_KEY to the end of the URL to be granted access
priority_claimsPopulates the priority claims for the publication
related_documentsPopulates all the related documents for the given publication (e.g. CIP, Divisions, etc)
titlesPopulates all the titles in every language provided for the given publication
uspcPopulates the UC Classifications if the publication is from the USPTO and data is provided
uspto_pairPopulates the USPTO PAIR data for the publication (Prosecution History, Term Adjustment, Office Actions)
uspto_ptabPopulates the usptoPtabTrials field if there are any USPTO PTAB trials associated with the US publication