Search

Contract Request APIs

 

Overview

Contract Request APIs improves visibility and integration of contract workflow information across your systems. These APIs enable real-time access to contract request details, allowing you to seamlessly incorporate this data into other platforms, such as your CRM for more accurate pipeline reporting.

The Contract Request APIs consist of two main components:

  • Request API - Retrieves contract request numbers using flexible date-based filtering, supporting:
    • Submission date ranges
    • Last updated date ranges
  • Request Details API - Provides information about a specific contract request, including:
    • Submitted By: who submitted a request
    • Request Type: specific values vary based on each organization but typical examples are “Sales Agreements”, “NDAs”, etc.
    • Description: typically captures a descriptive statement about what the request is for
    • Account: this is the name of the account the request is related to
    • Submitted On Date: date when request was initially submitted
    • Assignee: person assigned to work on the request
    • Status: the current status of the request inside the workflow. Values vary by organization.
    • Pramata number: in case a request results in a signed document, this captures the document identifier (Pramata Number) for the signed contract that is related to the request (Contract Request #).
    • Custom Metadata: includes all custom form fields

These APIs allow your IT teams to build integrations that do things like track the progress of contract requests, identify who's working on them, and understand their current status—all from within your existing systems in real-time.

 

Pre-requisites

To use this API, ensure you have the following:

  • API is enabled for the instance
  • Access to Pramata API Developer Portal (API client credentials are shared in the API portal). To get access, reach out to your Customer Success Manager.

 

Request API (Retrieve Contract Request Number)

Use the GET method to fetch contract request numbers using flexible date filtering. You can query requests based on two primary date parameters:

 

Submitted Date Range

API

https://[tenantname]-api-[env].pramata.com/services/data/v1/contract_requests/list?submitted_on_from=2024-08-30T07:00:00Z&submitted_on_to=2024-09-11T00:00:00Z

Last Updated Date Range

API

https://[tenantname]-api-[env].pramata.com/services/data/v1/contract_requests/list?modified_on_from=2024-04-30T07:00:00Z&modified_on_to=2024-09-11T00:00:00Z

 

In the above API endpoint, the following must be modified:

  • [tenantname]----> name of the tenant
  • [env] ----> uat or leave it blank for production environment
    Example: demo-api-uat.pramata.com/ demo-api.pramata.com
  • submitted_on_from and submitted_on_to---->YYYY-MM-DDThh:mm:ssZ
    • The timestamp portion Thh:mm:ssZ is optional
    • Examples:
      • With timestamp: 2024-08-30T07:00:00Z
      • Without timestamp: 2024-08-30
  • modified_on_from and modified_on_to---->YYYY-MM-DDThh:mm:ssZ
    • The timestamp Thh:mm:ssZ is optional
    • Examples:
      • With timestamp: 2024-08-30T07:00:00Z
      • Without timestamp: 2024-08-30

Example Request

https://demos-api.pramata.com/services/data/v1/contract_requests/list?submitted_on_from=2024-08-30T07:00:00Z&submitted_on_to=2024-09-11T00:00:00Z
https://demos-api.pramata.com/services/data/v1/contract_requests/list?modified_on_from=2024-08-30T07:00:00Z&modified_on_to=2024-09-11T00:00:00Z

API Response

{
"data": {
"contract_request_ids": [
10286,
10287,
10288
]
}
}

 

Request Details API

Use the GET method to retrieve contract request

API

https://[tenantname]-api-[env].pramata.com/services/data/v1/contract_requests/[contract_request_number]/details

In the above API endpoint, the following must be modified:

  • [tenantname]----> name of the tenant
  • [env] ----> uat or leave it blank for production environment
    Example: demo-api-uat.pramata.com/ demo-api.pramata.com
  • contract_request_number ----> contract request ID
    • Example: 10288

Example Request

https://demo-api.pramata.com/services/data/v1/contract_requests/10288/details

API Response

{
"contract_request_id": 10288,
"metadata": {
"submitted_by": "Jagadeeshwaran S",
"request_type": "NDA",
"description": "",
"account": "Globex Corporation",
"submitted_on_date": "2023-08-14T16:22:39.847Z",
"needed_by_date": null,
"priority": "Medium",
"assignee": "Jagadeeshwaran S",
"status": "Closed",
"pramata_number": 11367
},
"custom_data": [
{
"label": "Is the party insisting on using their NDA template?",
"value": "no"
},
{
"label": "Please enter the Opportunity ID",
"value": ""
},
{
"label": "Upload",
"value": "{\"data\":[]}"
},
{
"label": "What is the complete legal name of the other party?",
"value": "Company, Inc."
},
{
"label": "What is the address of the other party?",
"value": "123 Business Street"
},
{
"label": "What date should this NDA be effective from?",
"value": "2023-08-31T00:00:00-05:00"
},
{
"label": "Pramata Signing Date",
"value": "2023-08-31T00:00:00-05:00"
},
{
"label": "Legal name",
"value": "Company, Inc."
}
]
} }
}