{ "opencollection": "1.0.0", "info": { "name": "Helpcenter Contract API", "version": "1.0.0" }, "items": [ { "info": { "name": "Contract", "type": "folder" }, "items": [ { "info": { "name": "Update many contracts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/contracts/updateMany", "body": { "type": "json", "data": "{}" } }, "docs": "This API updates multiple contracts at once." }, { "info": { "name": "List all contracts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/contracts", "params": [ { "name": "accountId", "value": "", "type": "query" }, { "name": "include", "value": "", "type": "query" }, { "name": "ownerIds", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "sortBy", "value": "", "type": "query" }, { "name": "contractName", "value": "", "type": "query" }, { "name": "departmentIds", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query" } ] }, "docs": "To get a list of contracts" }, { "info": { "name": "Create a contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/contracts", "body": { "type": "json", "data": "{}" } }, "docs": "This API creates a contract in your helpdesk." }, { "info": { "name": "Get a contract", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/contracts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contract" } ] }, "docs": "This API fetches a single contract from your helpdesk." }, { "info": { "name": "Update a contract", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/contracts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the contract" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API updates details of an existing contact." }, { "info": { "name": "Get contract count by custom view and department", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/contracts/count", "params": [ { "name": "viewId", "value": "", "type": "query" }, { "name": "departmentId", "value": "", "type": "query" }, { "name": "ownerId", "value": "", "type": "query" } ] }, "docs": "This API return the count of contract based on the custom view and department specified. If ownerId is specified, it will return the count of contracts owned by the owner in the specified department." } ] } ], "bundled": true }