Skip to main content
Zoho contracts

Get Pending Obligations List

Purpose

To get the list of all the pending obligations owned by the user.

Endpoints

Request Details

Request URL

https://contracts.zoho.com/api/v1/pendingobligations?direction=desc&sortBy=dueDate

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.READ, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to pending obligations
READ - Get pending obligations

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/pendingobligations?direction=desc&sortBy=dueDate"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Response JSON Keys

  • modifiedTimestring

    Represents the time of modification.

  • apiNamestring

    Represents the name of the obligation in the API.

  • taskOwnersJSON Object

    Represents the ID of the obligation's owner.

  • instancesJSON Array

    Represents details of each instance of a recurring obligation.

  • sequenceNumberinteger

    Represents the ordinal number of an instance of a recurring obligation.

  • isOverDueboolean

    Represents whether the obligation task is overdue or not.

    ValueDescription
    TrueThe obligation's task is overdue.
    FalseThe obligation's task is not overdue.
  • isCurrentboolean

    Represents whether the obligation is currently being worked on or not.

    ValueDescription
    TrueThe obligation is currently being worked on.
    FalseThe obligation is not currently being worked on.
  • dueOnstring

    Represents the due date of the obligation task.

  • idstring

    Represents the ID of the particular obligation task instance.

  • actionsJSON Object

    Represents the history of status changes of each instance in an obligation.

  • createdOnstring

    Represents the date on which the obligation is created.

  • usersJSON Object

    Represents the task owners of the obligation.

  • statusinteger

    Represents the current status of the instance.

    ValueDescription
    11Not Started
    12In Progress
    14Completed
  • recurringJSON Array

    Represents whether the obligation's task is of a recurring type.

  • dueOnTerminationboolean

    Represents whether the recurring obligation ends with contract expiry or termination.

    ValueDescription
    TrueThe recurring obligation ends with contract expiry or termination.
    FalseThe recurring obligation does not end with contract expiry or termination.
  • timePeriodinteger

    Represents whether the recurring obligation is due for days, weeks, months or years of period in time.

    ValueDescription
    0Days
    1Weeks
    2Months
    3Years
  • startDateStringstring

    Represents the start date in dd/mm/yyyy format which gets returned when retrieving the obligation information.

  • startsOninteger

    Represents whether the start date of the recurring obligation's first instance is on a specific date or on the contract effective date.

    ValueDescription
    1Specific Date
    2On Effective Date
  • startDatestring

    Represents the start date in javascript milliseconds format.

  • frequencyinteger

    Represents the time interval in terms of the number of days, weeks, months, or year an obligation task instance is executed.

  • contractJSON Array

    Represents the details of the contract.

  • ownerJSON Object

    Represents the name of the contract owner.

  • apiNamestring

    Represents the name of the contract in the API.

  • systemStatusnumber

    Represents the status of the contract.

    ValueDescription
    12In Progress
    1Active
    9Terminated
    10Expired
    7On Hold
    3Termination Initiated
  • isActivenumber

    Represents whether the contract is active.

    ValueDescription
    1Active
    0Deleted
    5Archived
  • intentnumber

    Represents the intent of the contract.

    ValueDescription
    0Others
    1Buy
    2Sell
  • partyAnumber

    Represents the contracting party in a contract.

    ValueDescription
    0My Company
    1Counterparty
  • partyBnumber

    Represents the contracting party in a contract.

    ValueDescription
    0My Company
    1Counterparty
  • namestring

    Represents the name of the contract.

  • descriptionstring

    Represents the description of the obligation.

  • priorityinteger

    Represents the priority of the obligation.

    ValueDescription
    0Low
    1Medium
    2High
  • hasTaskboolean

    Represents whether the obligation is a task or not.

    ValueDescription
    TrueThe obligation is a task.
    FalseThe obligation is not a task.
  • namestring

    Represents the name of the obligation.

  • addedTimestring

    Represents the time the obligation is added.

  • categoryJSON Object

    Represents the category the obligation falls under.

  • statusinteger

    Represents the status of an obligation.

    ValueDescription
    0Deleted
    1Active
    13Paused
    14Completed
    16Yet to start
    17Scheduled

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect

Resolution: Specify a valid request URL. Refer to the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized

Resolution: Client does not have contracts.contracts.READ scope. Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to read

Resolution: The user does not have permission to read records. Contact your organization administrator.

INTERNAL_ERRORHTTP 500

Internal Server Error

Resolution: Unexpected and unhandled exception in the server.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

The user does not have sufficient privilege to read module details.

Resolution: The user does not have permission to retrieve module details. Contact your organization administrator.

Sample Response

Copied{
  "Obligation": [
    {
      "modifiedTime": String,
      "apiName": String,
      "taskOwners": [
        {
          "displayName": String,
          "id": String
        }
      ],
      "instances": [
        {
          "sequenceNumber": 14,
          "isOverDue": Boolean,
          "isCurrent": Boolean,
          "dueOn": String,
          "id": String,
          "actions": [],
          "createdOn": String,
          "users": [
            {
              "displayName": "Mohanesh",
              "id": String
            }
          ],
          "status": Number
        }
      ],
      "recurring": {
        "dueOnTermination": boolean,
        "timePeriod": Number,
        "exclude": [
          Number
        ],
        "startDateString": String,
        "startsOn": Number,
        "startDate": String,
        "frequency": Number
      },
      "contract": {
        "owner": {
          "displayName": String,
          "emailId": String,
          "id": String
        },
        "partyA": Number,
        "apiName": String,
        "systemStatus": Number,
        "partyB": Number,
        "name": "Specific Date",
        "isActive": Number,
        "intent": Number
      },
      "description": String,
      "priority": Number,
      "hasTask": Boolean,
      "name": String,
      "addedTime": String,
      "category": {
        "apiName": String,
        "displayName": String
      },
      "status": Number
    }
   ]
}

LEGEND

PRIORITY
        LOW - 0
        MEDIUM - 1
        HIGH - 2

STATUS
      DELETED - 0
      ACTIVE - 1
      PAUSED - 13
      COMPLETED - 14
      YET TO START - 16
      SCHEDULED - 17

INSTANCE_STATUS
               NOT_STARTED - 11
               IN PROGRESS - 12
               COMPLETED - 14

TIME_PERIOD
           DAYS - 0
           WEEKS - 1
           MONTHS - 2
           YEARS - 3

STARTS_ON
         SPECIFIC DATE - 1
         ON EFFECTIVE DATE -2

partyA
      MY_COMPANY - 0
      COUNTERPARTY - 1

systemstatus
            IN_PROGRESS - 12
            ACTIVE  - 1
            TERMINATED - 9
            EXPIRED - 10
            ON_HOLD - 7
            TERMINATION_INITIATED - 3

partyB
      MY_COMPANY - 0
      COUNTERPARTY - 1

isActive
        ACTIVE - 1
        DELETED - 0
        ARCHIVED - 5

intent
      OTHERS - 0
      BUY - 1
      SELL - 2

© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.

 Zoho Contracts Developer Community