Skip to navigation
API ReferenceAgreements

Get an agreement

Returns an agreement by ID.

Arguments

idStringRequired
The ID of the agreement to return.

Returns

an Agreement
accountLeadInstitutionBoolean
Whether the account is the lead institution.
agreementAccountClassificationslist of AgreementAccountClassifications
The links between the agreement and its account classifications.
agreementClassificationslist of AgreementClassifications
The links between the agreement and its global classifications.
agreementContactslist of AgreementContacts
The contacts involved in the agreement.
agreementJurisdictionslist of AgreementJurisdictions
The jurisdictions the agreement covers.
agreementMatterslist of AgreementMatters
The links between the agreement and the disclosures, filings, and patents it covers.
agreementOrganizationslist of AgreementOrganizations
The organizations party to the agreement.
agreementTermslist of AgreementTerms
The agreement's financial terms.
createdAtString
The agreement's creation date.
fieldsOfUseTaggingslist of Taggings

The field-of-use tags applied to the agreement.

idString
The agreement's unique identifier.
subLicensingBoolean

Whether sub-licensing is permitted.

thirdPartyInterestBoolean
Whether a third party has an interest in the agreement.
updatedAtString
The date the agreement was last updated.
accountPastPatentExpensesDoubleOptional
The patent expenses the account incurred before the agreement.
accountShareOfNetConsiderationDoubleOptional
The percentage of net consideration owed to the account.
accountShareOfPatentCostDoubleOptional
The percentage of patent costs borne by the account.
adminFeeAmountDoubleOptional
The fixed administrative fee.
adminFeeCapDoubleOptional
The maximum administrative fee.
adminFeePercentageDoubleOptional
The administrative fee as a percentage.
agreementDocumentsSummaryStringOptional
A summary of the documents attached to the agreement.
agreementNumberStringOptional
The agreement's number, assigned by the account.
amendedAgreementIdStringOptional
The unique identifier of the agreement this one amends.
amendedAtStringOptional
The date the agreement was last amended.
amendedByUserUserOptional
The user who last amended the agreement.
amendmentReasonStringOptional
The reason the agreement was last amended.
archivedAtStringOptional
The date the agreement was archived. Returns null if the agreement is active.
archivedByUserUserOptional
The user who archived the agreement.
beginOnStringOptional
The date the agreement term begins.
commentsCountIntegerOptional
The number of comments on the agreement.
createdByUserUserOptional
The user who created the agreement.
createdByUserIdStringOptional
The unique identifier of the user who created the agreement.
currencyStringOptional
The ISO 4217 currency code used by the agreement's monetary fields.
descriptionStringOptional
The agreement's description.
effectiveOnStringOptional
The date the agreement takes effect.
executionOnStringOptional
The date the agreement was executed.
expirationOnStringOptional
The date the agreement expires.
externalIdStringOptional
The agreement's identifier in an external system. Set when the agreement is imported.
fieldOfUseStringOptional
The field of use granted by the agreement.
lawFirmOrganizationOptional
The law firm handling the agreement.
licenseTypeEnumAgreementLicenseTypeEnumOptional
The exclusivity of the license.
Allowed values:
licensingIncomeSharePercentageDoubleOptional
The percentage of licensing income kept by the account.
licensingIncomeThresholdDoubleOptional
The income threshold above which the income share applies.
materialDescriptionStringOptional
A description of the material transferred. Applies to material transfer agreements.
materialDirectionEnumAgreementMaterialDirectionEnumOptional
Whether material is incoming or outgoing. Applies to material transfer agreements.
Allowed values:
materialFieldOfUseStringOptional
The field of use for the transferred material. Applies to material transfer agreements.
materialTitleStringOptional
The title of the material transferred. Applies to material transfer agreements.
matterDocumentsCountIntegerOptional
The number of documents attached to the agreement.
ndaExchangeTypeEnumAgreementNdaExchangeTypeEnumOptional
The direction of the information exchange. Applies to NDAs.
Allowed values:
ndaPurposeStringOptional
The purpose of the disclosure. Applies to NDAs.
netPaymentTermsIntegerOptional

The number of net payment term units. See netPaymentTermsLengthEnum for the unit.

netPaymentTermsLengthEnumPeriodUnitEnumOptional
The unit of the net payment terms, such as days or months.
Allowed values:
patentExpenseCapDoubleOptional
The maximum reimbursable patent expense.
requestedOnStringOptional
The date the agreement was requested.
signatureOnStringOptional
The date the agreement was signed.
sourceEnumAgreementSourceEnumOptional
How the agreement was created, such as manually or by import.
Allowed values:
statusLookupLookupUnionOptional

The agreement’s status. A global or account-specific lookup value.

subLicensingFeePercentageDoubleOptional

The fee on sub-licensing income as a percentage.

subLicensingQualificationStringOptional

The conditions under which sub-licensing is allowed.

subTypeEnumAgreementSubTypeEnumOptional

The agreement’s sub-type within its type.

terminatedOnStringOptional
The date the agreement was terminated.
thirdPartyInterestNotesStringOptional

Notes about third-party interests.

titleStringOptional
The agreement's title.
typeEnumAgreementTypeEnumOptional
The agreement's type, such as license, option, NDA, or MTA.
updatedByUserUserOptional
The user who last updated the agreement.
updatedByUserIdStringOptional
The unique identifier of the user who last updated the agreement.