List agreements | Tradespace | Developer Documentation

query ExampleQuery($agreementNumber: String, $amendedAgreementIds: [String!], $archived: ArchivedEnum, $beginOnMax: ISO8601Date, $beginOnMin: ISO8601Date, $contactIds: [String!], $createdByUserIds: [String!], $createdOnMax: ISO8601Date, $createdOnMin: ISO8601Date, $disclosureIds: [String!], $effectiveOnMax: ISO8601Date, $effectiveOnMin: ISO8601Date, $executionOnMax: ISO8601Date, $executionOnMin: ISO8601Date, $expirationOnMax: ISO8601Date, $expirationOnMin: ISO8601Date, $externalId: String, $filingIds: [String!], $licenseTypeEnums: [AgreementLicenseTypeEnum!], $limit: Int, $matterTypes: [String!], $organizationIds: [String!], $page: Int, $q: String, $requestedOnMax: ISO8601Date, $requestedOnMin: ISO8601Date, $signatureOnMax: ISO8601Date, $signatureOnMin: ISO8601Date, $sortDirection: SortDirectionEnum, $sortField: String, $sourceEnums: [AgreementSourceEnum!], $statusLookupIds: [String!], $subTypeEnums: [AgreementSubTypeEnum!], $terminatedOnMax: ISO8601Date, $terminatedOnMin: ISO8601Date, $typeEnums: [AgreementTypeEnum!], $updatedByUserIds: [String!], $updatedOnMax: ISO8601Date, $updatedOnMin: ISO8601Date) {
  agreements(agreementNumber: $agreementNumber, amendedAgreementIds: $amendedAgreementIds, archived: $archived, beginOnMax: $beginOnMax, beginOnMin: $beginOnMin, contactIds: $contactIds, createdByUserIds: $createdByUserIds, createdOnMax: $createdOnMax, createdOnMin: $createdOnMin, disclosureIds: $disclosureIds, effectiveOnMax: $effectiveOnMax, effectiveOnMin: $effectiveOnMin, executionOnMax: $executionOnMax, executionOnMin: $executionOnMin, expirationOnMax: $expirationOnMax, expirationOnMin: $expirationOnMin, externalId: $externalId, filingIds: $filingIds, licenseTypeEnums: $licenseTypeEnums, limit: $limit, matterTypes: $matterTypes, organizationIds: $organizationIds, page: $page, q: $q, requestedOnMax: $requestedOnMax, requestedOnMin: $requestedOnMin, signatureOnMax: $signatureOnMax, signatureOnMin: $signatureOnMin, sortDirection: $sortDirection, sortField: $sortField, sourceEnums: $sourceEnums, statusLookupIds: $statusLookupIds, subTypeEnums: $subTypeEnums, terminatedOnMax: $terminatedOnMax, terminatedOnMin: $terminatedOnMin, typeEnums: $typeEnums, updatedByUserIds: $updatedByUserIds, updatedOnMax: $updatedOnMax, updatedOnMin: $updatedOnMin) {
    collection {
      accountLeadInstitution
      accountPastPatentExpenses
      accountShareOfNetConsideration
      accountShareOfPatentCost
      adminFeeAmount
      adminFeeCap
      adminFeePercentage
      agreementAccountClassifications
      agreementClassifications
      agreementContacts
    }
    metadata {
      count
      currentPage
      extra
      hasNextPage
      hasPreviousPage
      limitValue
      nextPage
      previousPage
      totalCount
      totalPages
    }
  }
}

{
  "agreementNumber": "example",
  "amendedAgreementIds": [
    "example"
  ],
  "archived": "EXCLUDE",
  "beginOnMax": "example",
  "beginOnMin": "example",
  "contactIds": [
    "example"
  ],
  "createdByUserIds": [
    "example"
  ],
  "createdOnMax": "example",
  "createdOnMin": "example",
  "disclosureIds": [
    "example"
  ],
  "effectiveOnMax": "example",
  "effectiveOnMin": "example",
  "executionOnMax": "example",
  "executionOnMin": "example",
  "expirationOnMax": "example",
  "expirationOnMin": "example",
  "externalId": "example",
  "filingIds": [
    "example"
  ],
  "licenseTypeEnums": [
    "exclusive"
  ],
  "limit": 0,
  "matterTypes": [
    "example"
  ],
  "organizationIds": [
    "example"
  ],
  "page": 0,
  "q": "example",
  "requestedOnMax": "example",
  "requestedOnMin": "example",
  "signatureOnMax": "example",
  "signatureOnMin": "example",
  "sortDirection": "ASC",
  "sortField": "example",
  "sourceEnums": [
    "admin"
  ],
  "statusLookupIds": [
    "example"
  ],
  "subTypeEnums": [
    "consulting"
  ],
  "terminatedOnMax": "example",
  "terminatedOnMin": "example",
  "typeEnums": [
    "assignment"
  ],
  "updatedByUserIds": [
    "example"
  ],
  "updatedOnMax": "example",
  "updatedOnMin": "example"
}

{
  "data": {
    "agreements": {
      "collection": [
        {
          "accountLeadInstitution": true,
          "accountPastPatentExpenses": 0,
          "accountShareOfNetConsideration": 0,
          "accountShareOfPatentCost": 0,
          "adminFeeAmount": 0,
          "adminFeeCap": 0,
          "adminFeePercentage": 0,
          "agreementAccountClassifications": [
            {
              "accountClassification": null,
              "createdAt": null,
              "id": null,
              "updatedAt": null
            }
          ],
          "agreementClassifications": [
            {
              "classification": null,
              "createdAt": null,
              "id": null,
              "updatedAt": null
            }
          ],
          "agreementContacts": [
            {
              "contact": null,
              "contactRoleEnum": null,
              "createdAt": null,
              "department": null,
              "id": null,
              "revenueDistributionPercentage": null,
              "updatedAt": null
            }
          ]
        }
      ],
      "metadata": {
        "count": 0,
        "currentPage": 0,
        "extra": {},
        "hasNextPage": true,
        "hasPreviousPage": true,
        "limitValue": 0,
        "nextPage": 0,
        "previousPage": 0,
        "totalCount": 0,
        "totalPages": 0
      }
    }
  }
}

Returns a paginated collection of agreements.

Arguments

agreementNumberStringOptional

The agreement number to return. Matching is case-insensitive.

amendedAgreementIdslist of StringsOptional

The IDs of the agreements that the returned records amend.

archivedArchivedEnumOptional

The archived state of the records to return. The default is EXCLUDE.

Allowed values:

beginOnMaxStringOptional

The latest start date of the records to return.

beginOnMinStringOptional

The earliest start date of the records to return.

contactIdslist of StringsOptional

The IDs of the contacts linked to the records to return.

createdByUserIdslist of StringsOptional

The IDs of the users who created the records to return.

createdOnMaxStringOptional

The latest creation date to return.

createdOnMinStringOptional

The earliest creation date to return.

disclosureIdslist of StringsOptional

The IDs of the disclosures linked to the records to return.

effectiveOnMaxStringOptional

The latest effective date of the records to return.

effectiveOnMinStringOptional

The earliest effective date of the records to return.

executionOnMaxStringOptional

The latest execution date of the records to return.

executionOnMinStringOptional

The earliest execution date of the records to return.

expirationOnMaxStringOptional

The latest expiration date of the records to return.

expirationOnMinStringOptional

The earliest expiration date of the records to return.

externalIdStringOptional

The external identifier to return.

filingIdslist of StringsOptional

The IDs of the filings linked to the records to return.

licenseTypeEnumslist of AgreementLicenseTypeEnumsOptional

The license types of the agreements to return.

Allowed values:

limitIntegerOptional

The number of records returned. The default is 20, and the maximum is 500.

matterTypeslist of StringsOptional

The types of the linked matters, such as Disclosure or Patent.

organizationIdslist of StringsOptional

The IDs of the organizations linked to the records to return.

pageIntegerOptional

The page number to return. Starts at 1.

qStringOptional

The text to search for. Matches agreement number and title.

requestedOnMaxStringOptional

The latest request date of the records to return.

requestedOnMinStringOptional

The earliest request date of the records to return.

signatureOnMaxStringOptional

The latest signature date of the records to return.

signatureOnMinStringOptional

The earliest signature date of the records to return.

sortDirectionSortDirectionEnumOptional

The sort direction. The default is DESC.

Allowed values:

sortFieldStringOptional

The field to sort by. One of agreement_number, amended_at, archived_at, begin_on, created_at, effective_on, execution_on, expiration_on, license_type_enum, requested_on, signature_on, source_enum, status_lookup_id, sub_type_enum, terminated_on, title, type_enum, and updated_at. The default is created_at.

sourceEnumslist of AgreementSourceEnumsOptional

The source values of the records to return.

Allowed values:

statusLookupIdslist of StringsOptional

The IDs of the status lookup values of the records to return.

subTypeEnumslist of AgreementSubTypeEnumsOptional

The sub-types of the agreements to return.

terminatedOnMaxStringOptional

The latest termination date of the records to return.

terminatedOnMinStringOptional

The earliest termination date of the records to return.

typeEnumslist of AgreementTypeEnumsOptional

The types of the records to return.

updatedByUserIdslist of StringsOptional

The IDs of the users who last updated the records to return.

updatedOnMaxStringOptional

The latest last-updated date to return.

updatedOnMinStringOptional

The earliest last-updated date to return.

Returns

an AgreementCollection

collectionlist of Agreements

A collection of paginated AgreementCollection

metadataCollectionMetadata

Pagination Metadata for navigating the Pagination