Get Recently Changed Contracts

Prerequisites:

• You have the Subscription Key and Account Key that are needed for authentication. If you need these, speak with your IntelAgree Account Manager or Implementation Manager.

• You have a valid authentication token

Please see the Getting Started page for more information about how to obtain an authentication token, as well as a description of Business Keys and Impersonation, which are used when you create a Party. You can also download a Postman file from that page, which contains this and all other API operations so that you can test them.

Get a list of Changed Contracts

To get a list of Contracts that have recently been created, modified, or executed, you will call the GET /contracts operation with the following information:

Headers:

• "ApiVersion": "2.0", Required to specifiy version 2 of the API.

• "Ocp-Apim-Subscription-Key": Your subscription key. Required for all calls to the API

• "Authorization": Your authorization Bearer token. Required for all authenticated calls to the API.

Query String Parameters:

• actionType: Required. Specify “created”, “updated”, "executed", or "deleted" to filter the contract result as specified

• startDate: Required: Specify the Date/Time in UTC after which contracts that have been modified according to the actionType should be returned

• contractStatus: Optional. You can send one or more contract statuses. This filters the results to the contracts that are in one of the statuses specified.

• organizationId: Optional. Filters the results to contracts that belong to the Organization specified.

• businessSystem: Optional: You can specify one or more BusinessSystems Only Contracts that have a BusinessKey for the specified system(s) will be returned

• contractUpdateType: Optional. If actionType is "updated", this integer will be interpreted as a bitfield to further filter the results returned by which properties of the contract were modified as follows:

  • 1: Contract Metadata: return a contract if the primary metadata has been modifed (e.g. Contract Name)

  • 2: Attributes: return a contract if the ContractAttribute values have been modified

  • 4: Attachments: return a contract if any Attachments have been added or removed

  • 8: Relationships: return a contract if any relationships have been modified

  • 16: Approvals: return a contract if there has been any change to the contract approvals

  • 32: Versions: return a contract if there has been a new version of the document

• pageSize: Optional. The number of results per page. Defaults to 500

• pageNumber: Optional. The page of results to return. Defaults to 1

Examples

• GET /contracts?actionType=create&startDate=2023-01-01T12:00:00Z

  • Gets all contracts that were created after January 1st, 2023.

• GET /contracts?actionType=updated&startDate=2023-01-01T12:00:00Z&contractStatus=Executed&contractStatus=Generated&businessSystem=Salesforce&contractUpdateType=6

  • Gets all Salesforce contracts that are currently in the Generated or Executed status that have their Attributes or Attachments changed after January 1st, 2023