GET
/
contracts
List Contracts
curl --request GET \
  --url https://connect.withvayu.com/contracts \
  --header 'Authorization: Bearer <token>'
{
  "contracts": [
    {
      "startDate": "2023-11-07T05:31:56Z",
      "customerId": "<string>",
      "name": "<string>",
      "salesForceOpportunityId": "<string>",
      "endDate": "2023-11-07T05:31:56Z",
      "products": [
        {
          "displayName": "<string>",
          "description": "<string>",
          "scheduling": {
            "billingDay": 1,
            "duration": {
              "unit": "MONTH",
              "value": 500
            }
          },
          "pricing": {
            "type": "ONE_TIME",
            "price": 1
          },
          "catalogProductId": "<string>",
          "productErpId": "<string>"
        }
      ],
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10
Required range: 1 <= x <= 1000
cursor
string

Response

RequestSuccess

contracts
object[]
required
total
number
required
hasMore
boolean
required
nextCursor
string