Zoho Sprints

https://sprints.zoho.com/apidoc.html
Admin
Zoho Sprints API is a REST-based API that uses Oauth 2.0 for authentication, enabling users to fetch...
Tokens:248,461
Snippets:1,078
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Module Layout Example

Source: https://sprints.zoho.com/apidoc.html#Overview

This example demonstrates how to fetch the layout of a specific module using cURL. Ensure you replace placeholders with your actual team ID, module ID, and authorization token.

```bash
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/settings/customization/modules/2000000000105/layout/?action=data&index=1&range=10 \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

--------------------------------

### Start Sprint Request

Source: https://sprints.zoho.com/apidoc.html#Overview

Use this cURL command to initiate a sprint. This action requires the sprint to be in a state where it can be started.

```bash
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/sprints/579000000062055/start/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

--------------------------------

### Create Objective/Key Result Request Example

Source: https://sprints.zoho.com/apidoc.html#Overview

Example of a cURL request to create a new Objective/Key Result. Ensure to replace placeholders with actual values and include the correct Authorization header.

```bash
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/okrs/4000000026029/okrs/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3' --data '{"title":"***","weightage":"1","valueUnit":"1","initialValue":"0.6","finalValue":"1","currentValue":"0.6","statusId":"4000000000137","startDate":"2025-01-01T00:00:00+05:30","endDate":"2025-12-31T00:00:00+05:30","description":"<div>***</div>","addedAssignees":"[\"4000000000005\"]","type":"2"}'
```

--------------------------------

### Example API Response for items

Source: https://sprints.zoho.com/apidoc.html#Overview

This is an example response when fetching items. It includes item properties, IDs, user display names, and detailed item objects with their associated data.

```json
{
  "next": false,
  "item_prop": {
    "endDate": 6,
    "hasSubHierarchy": 34,
    "isNotesAdded": 10,
    "itemNo": 1,
    "ownerId": 27,
    "addedVia": 17,
    "leftPosition": 7,
    "points": 13,
    "duration": 3,
    "itemName": 0,
    "isOverDue": 28,
    "diffDays": 29,
    "startAfter": 18,
    "createdTime": 16,
    "rightPosition": 8,
    "rootItem": 22,
    "isDocsAdded": 11,
    "projPriorityId": 25,
    "immediateRootId": 32,
    "immediateParentId": 33,
    "isParent": 9,
    "level": 31,
    "directChilds": 30,
    "completedDate": 15,
    "commentCount": 19,
    "sequence": 12,
    "sprintId": 20,
    "depth": 4,
    "statusId": 23,
    "epicId": 26,
    "createdBy": 2,
    "parentItem": 21,
    "projItemTypeId": 24,
    "isOrphanItem": 35,
    "startDate": 5,
    "completedBy": 14
  },
  "itemIds": [
    "2000000006321",
    "2000000006323",
    "2000000006327"
  ],
  "userDisplayName": {
    "2000000000007": "Unassigned",
    "2000000000005": "John Doe"
  },
  "itemJObj": {
    "2000000006321": [
      "As a user, I would like to read some blogs and tips on buying appliances.",
      "37",
      "2000000000005",
      "8h",
      "0",
      "-1",
      "-1",
      1,
      2,
      false,
      false,
      false,
      "37",
      2,
      "",
      "-1",
      "2024-05-04T06:31:30.707Z",
      4,
      "-1",
      0,
      "2000000006247",
      "",
      "",
      "2000000005499",
      "2000000006235",
      "2000000006225",
      "",
      [
        "2000000000007"
      ],
      false,
      "",
      [],
      1,
      "",
      "",
      false,
      false
    ],
    "2000000006323": [
      "Promote on social media ",
      "38",
      "2000000000005",
      "5d 12h",
      "0",
      "-1",
      "-1",
      1,
      4,
      true,
      false,
      false,
      "38",
      1,
      "",
      "-1",
      "2024-05-04T06:31:30.707Z",
      4,
      "-1",
      0,
      "2000000006247",
      "",
      "",
      "2000000005499",
      "2000000006235",
      "2000000006227",
      "",
      [
        "2000000000007"
      ],
      false,
      "",
      [],
      1,
      "",
      "",
      true,
      false
    ],
    "2000000006327": [
      "Trigger emailers to active users",
      "40",
      "2000000000005",
      "2d 12h",
      "0",
      "-1",
      "-1",
      1,
      2,
      false,
      false,
      false,
      "40",
      3,
      "",
      "2024-04-30T23:00:00.000Z",
      "2024-05-01T06:31:30.707Z",
      4,
      "-1",
      0,
      "2000000006247",
      "",
      "",
      "2000000005499",
      "2000000006233",
      "2000000006227",
      "",
      [
        "2000000000005"
      ],
      false,
      "",
      [],
      1,
      "",
      "",
      false,
      false
    ]
  },
  "zsuserIdvsZUID": {
    "2000000000007": "-1",
    "2000000000005": "19942893"
  },
  "status": "success"
}
```

--------------------------------

### Get Extension Epic Data Request

Source: https://sprints.zoho.com/apidoc.html#Overview

Example of a GET request to retrieve extension data for a specific epic.

```bash
curl -X GET https://sprintsapi.zoho.com/zsapi/team/7*****4/projects/19091*******7713/epic/190910000********/extensions/190910000000*****/data \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

--------------------------------

### Start Sprint

Source: https://sprints.zoho.com/apidoc.html#Overview

Starts a specific sprint. Requires team ID, project ID, and sprint ID.

```APIDOC
## POST {APIEndPoint}/team/{teamId}/projects/{projectId}/sprints/{sprintId}/start/

### Description
Starts a specific sprint. Requires team ID, project ID, and sprint ID.

### Method
POST

### Endpoint
{APIEndPoint}/team/{teamId}/projects/{projectId}/sprints/{sprintId}/start/

### Request Example
```bash
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/sprints/579000000062055/start/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

### Response
#### Success Response (200)
- **sprintNo** (Number) - The sprint number.
- **status** (String) - Indicates the success status of the operation.

### Response Example
```json
{ "sprintNo": 7, "status": "success" }
```
```

--------------------------------

### Start Sprint Response

Source: https://sprints.zoho.com/apidoc.html

A successful sprint start returns the sprint number and a status of 'success'.

```json
{ sprintNo: 7, status: "success" }
```

--------------------------------

### Get Project Details

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetches the details of a specific project.

```APIDOC
## GET {APIEndPoint}/team/{teamId}/projects/{projectId}/

### Description
Fetch the details of a specific project.

### Method
GET

### Endpoint
{APIEndPoint}/team/{teamId}/projects/{projectId}/

### Parameters
*Note: No specific query parameters are listed for this operation in the source text. It is assumed that the projectId in the path is sufficient for retrieval.* 

### Request Example
*Example request would be similar to Get Project Backlog, but without the `action=getbacklog` query parameter, assuming the API defaults to fetching details when no action is specified.*
```
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

### Response
*The response structure for project details is not explicitly provided in the source text. It is expected to contain comprehensive information about the project.*

#### Success Response (200)
*Details about the project (e.g., name, status, dates, owner, etc.).*

#### Response Example
*Example response structure is not available in the source text.*
```

--------------------------------

### Get Release Details

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetches the details of a specific release using its ID.

```curl
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/release/579000000121139/?action=data \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

--------------------------------

### Example API Request to fetch items

Source: https://sprints.zoho.com/apidoc.html#Overview

This cURL command demonstrates how to fetch items from a specific sprint, using action=data and index/range parameters. Ensure you include the correct Authorization header.

```bash
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/sprints/579000000062055/item/?action=data&index=1&range=2 \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

--------------------------------

### Create Project API Request

Source: https://sprints.zoho.com/apidoc.html#Overview

This example demonstrates how to create a new project using the Zoho Sprints API. It includes various standard and custom fields.

```bash
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3' \
--data-urlencode'name=Online Shopping - Demo Project' \
--data-urlencode'desc=' \
--data-urlencode'owner=579000000002003' \
--data-urlencode'projgroup=579000000002033' \
--data-urlencode'itemlayoutid=1026000000026003' \
--data-urlencode'epiclayoutid=1026000000026005' \
--data-urlencode'meetinglayoutid=1026000000026007' \
--data-urlencode'projectlayoutid=1026000000026007' \
--data-urlencode'prefix=SP' \
--data-urlencode'estimationtype=0' \
--data-urlencode'startdate=2017-07-31T18:30:00+05:30' \
--data-urlencode'enddate=2017-11-29T18:30:00+05:30' \
--data-urlencode'pointsarr=' \
--data-urlencode'UDF_DATE1=2017-11-22T16:30:00+05:30' \
--data-urlencode'UDF_DATETIME1=2017-11-22T16:30:00+05:30' \
--data-urlencode'UDF_TEXT1=Text area content' \
--data-urlencode'UDF_LONG1=1' \
--data-urlencode'UDF_PKL1=2000000009049' \
--data-urlencode'UDF_RADIO1=2000000009057' \
--data-urlencode'UDF_MULTIPKL1=["1736000000003109","1736000000003111","1736000000003113"]' \
--data-urlencode'UDF_CHKBOX1=["2000000009069"]' \
--data-urlencode'UDF_DOUBLE1=0.1' \
--data-urlencode'UDF_URI1=https://www.google.com' \
--data-urlencode'UDF_EMAIL1=nicholas@zylker.com' \
--data-urlencode'UDF_BOOLEAN1=2000000009075' \
--data-urlencode'UDF_USERPKL1=2000000009075'
```

--------------------------------

### Get Expense Comments

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetches the comments of a specific expense. You can specify the starting index and the number of records to retrieve.

```APIDOC
## GET /zsapi/team/{teamId}/projects/{projectId}/modules/{moduleId}/entity/{expenseId}/notes/

### Description
Fetches the comments of a specific expense. You can specify the starting index and the number of records to retrieve. Refer to Get modules to fetch the list of available modules.

### Method
GET

### Endpoint
{APIEndPoint}/team/{teamId}/projects/{projectId}/modules/{moduleId}/entity/{expenseId}/notes/

### Parameters
#### Query Parameters
- **action** (String) - Required - Must be set to "data".
- **index** (Integer) - Required - The index from which the listing should start. Valid index starts from 1.
- **range** (Integer) - Required - The number of records to list. The maximum limit is 250.

### Request Example
```bash
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/modules/579000000062055/entity/579000000062089/notes/?action=data&index=1&range=10 \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

### Response
#### Success Response (200)
- **attachments** (Object) - Contains attachment information.
- **hasData** (Boolean) - Indicates if there is data available.
- **next** (Boolean) - Indicates if there are more records.
- **notes_prop** (Object) - Properties related to the notes.
- **notesIds** (Array) - List of note IDs.
- **notesJObj** (Object) - A JSON object containing detailed note information.
- **permission_prop** (Object) - Properties related to permissions.
- **permissionJObj** (Object) - A JSON object containing detailed permission information.
- **status** (String) - Indicates the result of the operation, e.g., "success".
- **userDisplayName** (Object) - Maps user IDs to display names.
- **zsuserIdvsZUID** (Object) - Maps Zoho Sprints user IDs to ZUIDs.

#### Response Example
```json
{
  "attachments": {},
  "hasData": true,
  "next": false,
  "notes_prop": {
    "addedVia": 14,
    "childSeq": 9,
    "createdBy": 2,
    "createdOn": 3,
    "hasAttach": 6,
    "noteId": 0,
    "notes": 1,
    "oEmbedData": 13,
    "parentCommentId": 7,
    "parentSeq": 8,
    "reactions": 10,
    "totalReaction": 11,
    "totalReply": 12,
    "updatedBy": 4,
    "updatedOn": 5
  },
  "notesIds": ["1026000000997001"],
  "notesJObj": {
    "1026000000997001": [
      "1026000000997001",
      "This travel expense occurred during our client meeting.",
      "1026000000003003",
      "2024-07-02T09:39:21.483Z",
      "1026000000003003",
      "2024-07-02T09:39:21.483Z",
      0,
      null,
      "1",
      0,
      null,
      0,
      0,
      null,
      0
    ]
  },
  "permission_prop": {
    "hasDeletePermission": 1,
    "hasEditPermission": 0
  },
  "permissionJObj": {
    "1026000000997001": [
      true,
      true
    ]
  },
  "status": "success",
  "userDisplayName": {
    "1026000000003003": "John Doe"
  },
  "zsuserIdvsZUID": {
    "1026000000003003": "55427795"
  }
}
```
```

--------------------------------

### Get Extension Epic Data Response

Source: https://sprints.zoho.com/apidoc.html#Overview

Example response containing extension data, including attachments and ETag.

```json
{ data: { attachments: [ "418hn8650b3e6f29c499eb998720a2d95085c" ] }, ETag: "3585b26fdc28******1e30114bf9", status: "success" }
```

--------------------------------

### Get custom fields in a project

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetch the list of custom fields for a module in a specific project. To add or update custom fields, parameter names must start with 'UDF_'.

```APIDOC
## GET {APIEndPoint}/team/{teamId}/projects/{projectId}/modules/{moduleId}/

### Description
Fetch the list of custom fields for a module in a specific project.

### Method
GET

### Endpoint
{APIEndPoint}/team/{teamId}/projects/{projectId}/modules/{moduleId}/

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to "formfields".

### Request Example
```bash
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/2000000000201/modules/2000000000101/?action=formfields \
  -H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

### Response
#### Success Response (200)
- **sectionVSfields** (object) - Contains field details organized by section.
- **sectionData** (object) - Contains information about sections.
- **customfield_prop** (object) - Properties related to custom fields.
- **optgroup_prop** (object) - Properties related to option groups.
- **options_prop** (object) - Properties related to options.

#### Response Example
```json
{
  "sectionVSfields": {
    "2000000000117": {
      "fieldJObj": {
        "2000000000149": [ 4, "", "", false, "", "", "", [], 2, {}, 0 ],
        "2000000000151": [ 5, "", "", false, "", "", "", [], 4, {}, 0 ],
        "2000000000141": [ 1, "", "", false, "", "", "", [], 2, {}, 0 ],
        "2000000000153": [ 6, "", "", false, "", "", "", [], 4, {}, 0 ],
        "2000000000165": [ 10, "", "", false, "", "", "", [], 2, {}, 0 ],
        "2000000000155": [ 7, "", "", false, "", "", "", [], 1, {}, 0 ],
        "2000000000145": [ 2, "", "", false, "", "", "", [], 2, {}, 0 ],
        "2000000000157": [ 8, "", "", false, "", "", "", [], 1, {}, 0 ],
        "2000000000147": [ 3, "", "", false, "", "", "", [], 2, {}, 0 ],
        "2000000000137": [ 0, "", "", false, "", "", "", [], 2, {}, 0 ],
        "2000000000159": [ 9, "", "", false, "", "", "", [], 2, {}, 0 ]
      },
      "fieldIds": [ "2000000000137", "2000000000141", "2000000000145", "2000000000147", "2000000000149", "2000000000151", "2000000000153", "2000000000155", "2000000000157", "2000000000159", "2000000000165" ]
    }
  },
  "sectionData": {
    "customsection_prop": {
      "sectionName": 1,
      "sequence": 3,
      "isDefault": 2,
      "createdBy": 4,
      "createdTime": 5,
      "layoutId": 0
    },
    "customsectionIds": [ "2000000000117" ],
    "customsectionJObj": {
      "2000000000117": [ "2000000000101", "Default Section", true, 1, "2000000000009", "2023-04-21T11:50:13.879Z" ]
    }
  },
  "customfield_prop": {
    "sequence": 0,
    "fieldProperties": 7,
    "defaultValue": 1,
    "tooltip": 5,
    "formulaValue": 6,
    "optionGroups": 9,
    "placeholder": 4,
    "fieldPermission": 10,
    "validation": 2,
    "isMandatory": 3,
    "returnType": 8
  },
  "optgroup_prop": {
    "groupName": 0,
    "options": 1
  },
  "options_prop": {
    "optionTitle": 0,
    "isDefault": 2,
    "userId": 1
  },
  "status": "success"
}
```

--------------------------------

### Link Item Example

Source: https://sprints.zoho.com/apidoc.html#Overview

This cURL command demonstrates how to link an item to a sprint and project using the Zoho Sprints API. Ensure you have the correct Authorization header and provide all required data-urlencode parameters.

```curl
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/sprints/579000000062055/item/579000000062089/linkitem/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3' \
--data-urlencode'action=linkitems' \
--data-urlencode'linkitemobj={'directlink':['1026000000003119']}' \
--data-urlencode'linktosprintid=1026000000003091' \
--data-urlencode'linktoprojectid=1026000000003053' \
--data-urlencode'linktypeid=1026000000064005'
```

--------------------------------

### Get Portfolio View of Custom Module Records (Global Scope)

Source: https://sprints.zoho.com/apidoc.html#Overview

Retrieves a paginated list of custom module records for a given module within a team. Use this to fetch records starting from a specific index and with a defined range.

```curl
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/6243****62635/modules/531******43253/portfolioview/?action=data&index=1&range=10 \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

--------------------------------

### Example Response for Creating OKR

Source: https://sprints.zoho.com/apidoc.html#Overview

This is a sample successful response when creating an Objective/Key Result. It confirms the creation and provides details of the newly created OKR, including its ID, owner, dates, and status.

```json
{
  "linkedEntityCount": 0,
  "okr": {
    "updatedBy": "4000000000005",
    "endDate": "1738261800000",
    "description": "",
    "assignees": [],
    "updatedOn": "1737355761809",
    "type": 1,
    "title": "***",
    "ownerId": "4000000000005",
    "createdOn": "1737355761809",
    "commentCount": "0",
    "tags": [],
    "shortNumber": "8",
    "userGroups": [],
    "percentageCompleted": "0.0",
    "depth": "0",
    "statusId": "4000000000137",
    "createdBy": "4000000000005",
    "attachmentCount": "0",
    "id": "4000000030021",
    "position": "0",
    "startDate": "1735669800000",
    "status": {
      "sequence": 1,
      "name": "Active",
      "colourCode": "#edf8f3",
      "id": "4000000000137"
    }
  },
  "affectedOkrs": [],
  "users": {
    "4000000000005": {
      "name": "John Doe",
      "id": "4000000000005",
      "zuid": "28097124"
    }
  },
  "okrId": "4000000030021",
  "status": "success"
}
```

--------------------------------

### Create Epic Request

Source: https://sprints.zoho.com/apidoc.html#Overview

Example of a POST request to create a new epic, including various parameter types like strings, numbers, dates, and custom fields.

```bash
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000094001/epic/1736000000015013/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3' --data '{name: "Epic feature development", owner: 1736000000003003, UDF_CHAR1: "Qwerty", UDF_DATE1: "2017-11-22T16:30:00+05:30", UDF_DATETIME1: "2017-11-23T16:30:00+05:30", UDF_TEXT1: "Text area content"}'
```

--------------------------------

### Create Epic Response

Source: https://sprints.zoho.com/apidoc.html

Example response after successfully creating an epic, including its ID and associated properties.

```json
{
  "epicJObj": {
    "1736000000015013": [
      "Epic feature development",
      "#259e92",
      6,
      "6",
      "1736000000003003",
      0,
      "1736000000003003",
      "2018-04-11T10:28:13.940Z",
      "",
      0,
      ""
    ]
  },
  "epicIds": [
    "1736000000015013"
  ],
  "epic_prop": {
    "owner": 4,
    "epicType": 8,
    "sequence": 2,
    "epicNo": 3,
    "epicName": 0,
    "createdBy": 6,
    "epicStatus": 5,
    "createdTime": 7,
    "description": 9,
    "colorCode": 1
  },
  "status": "success"
}
```

--------------------------------

### Get Expense Attachments

Source: https://sprints.zoho.com/apidoc.html#Overview

Retrieve all attachments associated with a specific expense. The 'action' parameter must be set to 'get'.

```curl
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/1000000007177/expenses/1000000016013/attachments/?action=get \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

--------------------------------

### Get Extension Sprint Data

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetch the existing extension data in the specified sprint using a GET request.

```APIDOC
## GET {APIEndPoint}/team/{teamId}/projects/{projectId}/sprints/{sprintId}/extensions/{extensionId}/data

### Description
Used to fetch the existing extension data in the specified sprint.

### Method
GET

### Endpoint
{APIEndPoint}/team/{teamId}/projects/{projectId}/sprints/{sprintId}/extensions/{extensionId}/data

### Response Codes
200| Request completed successfully.
404| Request completed successfully. Getting 404 due to lack of data.

### Request Example
```curl
curl -X GET https://sprintsapi.zoho.com/zsapi/team/7*****4/projects/19091*******7713/sprints/190910000********/extensions/190910000000*****/data  \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

### Response Example
```json
{ data: { attachments: [ "418hn8650b3e6f29c499eb998720a2d95085c" ] }, ETag: "3585b26fdc28******1e30114bf9", status: "success" }
```
```

--------------------------------

### Example Response for Linking Item

Source: https://sprints.zoho.com/apidoc.html#Overview

This JSON object represents a successful response after linking an item. It includes details about the item's properties, permissions, and status.

```json
{
  "item_prop": {
    "itemId": 3,
    "itemName": 1,
    "itemNo": 2,
    "linkMap": 16,
    "ownerId": 15,
    "projectId": 9,
    "projId": 12,
    "projItemTypeId": 8,
    "projName": 13,
    "projNo": 14,
    "sprintId": 6,
    "sprintName": 10,
    "sprintType": 5,
    "statusId": 7,
    "workflowId": 11
  },
  "itemIds": [
    "2000000006251"
  ],
  "itemJObj": {
    "2000000006251": [
      "2000000006251",
      "As a user, I would like to receive weekly mails on the latest appliances on your site.",
      "2",
      "2000000006251",
      "2000000006199",
      5,
      "2000000006199",
      "2000000005499",
      "2000000006235",
      "2000000006193",
      "Backlog",
      "2000000006192",
      "2000000006193",
      "Sample Project",
      "1",
      [
        "2000000000007"
      ],
      {
        "2000000006249": {
          "2000000005505": 1
        }
      }
    ]
  },
  "permission_prop": {
    "hasViewPermission": 0
  },
  "permissionJObj": {
    "2000000006251": [
      true
    ]
  },
  "status": "success",
  "userDisplayName": {
    "2000000000007": "Unassigned"
  },
  "zsuserIdvsZUID": {
    "2000000000007": "-1"
  }
}
```

--------------------------------

### Create Epic with Custom Fields

Source: https://sprints.zoho.com/apidoc.html#Overview

Use this endpoint to create a new epic, including custom fields like UDF_CHAR1, UDF_DATE1, UDF_DATETIME1, and UDF_TEXT1. Ensure the Authorization header is correctly set.

```bash
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000094001/epic/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3' --data '{name: "Epic feature development", owner: 1736000000003003, UDF_CHAR1: "Qwerty", UDF_DATE1: "2017-11-22T16:30:00+05:30", UDF_DATETIME1: "2017-11-23T16:30:00+05:30", UDF_TEXT1: "Text area content"}'
```

--------------------------------

### Get Expense Categories

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetch all available expense categories within a workspace. This GET request requires the team ID.

```HTTP
GET
{APIEndPoint}/team/{teamId}/expensecategories/
```

--------------------------------

### Get sprint comments

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetch the comments of a specific sprint. Refer Get modules to fetch the list of available modules.

```APIDOC
## GET {APIEndPoint}/team/{teamId}/projects/{projectId}/modules/{moduleId}/entity/{sprintId}/notes/

### Description
Fetch the comments of a specific sprint. Refer Get modules to fetch the list of available modules.

### Scope
ZohoSprints.comments.READ

### Method
GET

### Endpoint
{APIEndPoint}/team/{teamId}/projects/{projectId}/modules/{moduleId}/entity/{sprintId}/notes/

### Parameters
#### Path Parameters
- **teamId** (string) - Required - The ID of the team.
- **projectId** (string) - Required - The ID of the project.
- **moduleId** (string) - Required - The ID of the module.
- **sprintId** (string) - Required - The ID of the sprint.

### Request Example
```bash
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/modules/12345/entity/579000000062055/notes/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

### Response
#### Success Response (200)
(Response structure for comments is not detailed in the source text, but would typically include a list of comments with their content, author, and timestamp.)

### Response Example
(Response example for comments is not detailed in the source text.)
```

--------------------------------

### Create Project

Source: https://sprints.zoho.com/apidoc.html#Overview

This endpoint allows you to create a new project. You can specify various details such as project name, owner, dates, and custom fields.

```APIDOC
## POST /zsapi/team/{teamId}/projects/

### Description
Creates a new project within a specified team.

### Method
POST

### Endpoint
/zsapi/team/{teamId}/projects/

### Parameters
#### Path Parameters
- **teamId** (string) - Required - The ID of the team to which the project will belong.

#### Query Parameters
- **name** (string) - Required - Name of the project.
- **desc** (string) - Optional - Detailed overview of the project.
- **owner** (long) - Required - User ID of the manager who is assigned to the project.
- **projgroup** (long) - Required - ID of the project group to which this project belongs.
- **itemlayoutid** (long) - Optional - ID of the item layout to which this project to be associated.
- **epiclayoutid** (long) - Optional - ID of the epic layout to which this project to be associated.
- **meetinglayoutid** (long) - Optional - ID of the meeting layout to which this project to be associated.
- **projectlayoutid** (long) - Optional - ID of the project layout to which this project is to be associated.
- **prefix** (string) - Optional - Project prefix can only have up to 3 characters.
- **estimationtype** (int) - Optional - Maps an estimation type for your project. 0 - Fibanacci, 2 - Custom.
- **startdate** (string) - Optional - Date on which the project is expected to start. **yyyy-MM-dd'T'HH:mm:ssZ (ISO format)**
- **enddate** (string) - Optional - Tentative end date of the project. **yyyy-MM-dd'T'HH:mm:ssZ (ISO format)**
- **pointsarr** (JSONArray) - Optional - If the estimation type is "custom", this param is mandatory. A maximum of 15 estimation points can only be set.
- **clonefrom** (long) - Optional - Pass ID of the project template from which this project is to be created.
- **UDF_CHAR[1-20]** (string) - Optional - Single-line field. Refer here to get the UDF Name. Maximum of 250 characters are allowed.
- **UDF_DATE[1-10]** (date) - Optional - Date field. Refer here to get the UDF Name.
- **UDF_TEXT[1-20]** (string) - Optional - Text area field. Refer here to get the UDF Name. Maximum of 99999 characters are allowed.
- **UDF_LONG[1-10]** (long) - Optional - Long field. Refer here to get the UDF Name.
- **UDF_PKL[1-10]** (long) - Optional - Picklist field. Refer here to get the UDF Name.
- **UDF_RADIO[1-10]** (long) - Optional - Radio button field. Refer here to get the UDF Name.
- **UDF_RTEXT[1-20]** (string) - Optional - Html field. Refer here to get the UDF Name. Maximum of 99999 characters are allowed.
- **UDF_MULTIPKL[1-10]** (JSONArray) - Optional - Multi picklist field. Refer here to get the UDF Name.
- **UDF_CHKBOX[1-10]** (JSONArray) - Optional - Checkbox field. Refer here to get the UDF Name.
- **UDF_DOUBLE[1-10]** (float) - Optional - Double field. Refer here to get the UDF Name.
- **UDF_URI[1-10]** (string) - Optional - Url field. Refer here to get the UDF Name. Maximum of 250 characters are allowed.
- **UDF_EMAIL[1-10]** (string) - Optional - Email field. Refer here to get the UDF Name. Maximum of 150 characters are allowed.
- **UDF_BOOLEAN[1-10]** (long) - Optional - Boolean field. Refer here to get the UDF Name.
- **UDF_USERPKL[1-20]** (long) - Optional - User picklist field. Refer here to get the UDF Name.
- **UDF_DATETIME[1-10]** (date) - Optional - Date-time field. Refer here to get the UDF Name.

### Request Example
```bash
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3' \
--data-urlencode'name=Online Shopping - Demo Project' \
--data-urlencode'desc=' ' \
--data-urlencode'owner=579000000002003' \
--data-urlencode'projgroup=579000000002033' \
--data-urlencode'itemlayoutid=1026000000026003' \
--data-urlencode'epiclayoutid=1026000000026005' \
--data-urlencode'meetinglayoutid=1026000000026007' \
--data-urlencode'projectlayoutid=1026000000026007' \
--data-urlencode'prefix=SP' \
--data-urlencode'estimationtype=0' \
--data-urlencode'startdate=2017-07-31T18:30:00+05:30' \
--data-urlencode'enddate=2017-11-29T18:30:00+05:30' \
--data-urlencode'pointsarr=' \
--data-urlencode'UDF_DATE1=2017-11-22T16:30:00+05:30' \
--data-urlencode'UDF_DATETIME1=2017-11-22T16:30:00+05:30' \
--data-urlencode'UDF_TEXT1=Text area content' \
--data-urlencode'UDF_LONG1=1' \
--data-urlencode'UDF_PKL1=2000000009049' \
--data-urlencode'UDF_RADIO1=2000000009057' \
--data-urlencode'UDF_MULTIPKL1=["1736000000003109","1736000000003111","1736000000003113"]' \
--data-urlencode'UDF_CHKBOX1=["2000000009069"]' \
--data-urlencode'UDF_DOUBLE1=0.1' \
--data-urlencode'UDF_URI1=https://www.google.com' \
--data-urlencode'UDF_EMAIL1=nicholas@zylker.com' \
--data-urlencode'UDF_BOOLEAN1=2000000009075' \
--data-urlencode'UDF_USERPKL1=2000000009075'
```

### Response
#### Success Response (200)
- **id** (long) - The unique identifier of the newly created project.
- **name** (string) - The name of the created project.
- **message** (string) - A success message indicating the project was created.

#### Response Example
```json
{
  "id": 579000000003001,
  "name": "Online Shopping - Demo Project",
  "message": "Project created successfully."
}
```

#### Error Response (400)
- **code** (int) - The error code.
- **message** (string) - A message describing the error.

#### Error Response Example
```json
{
  "code": 1001,
  "message": "Invalid input parameters."
}
```
```

--------------------------------

### Get Project Details

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetches the details of a specific project. This endpoint requires the 'action=details' parameter.

```curl
curl -X GET https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/579000000062001/?action=details \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```

--------------------------------

### Get Item Statuses in Project

Source: https://sprints.zoho.com/apidoc.html

Fetch the item statuses for a specific project. This API is used to retrieve the current status of items within a project.

```GET
GET
{APIEndPoint}/team/{teamId}/projects/{projectId}/itemstatus/
```

--------------------------------

### Create Custom Module Record (Global Scope)

Source: https://sprints.zoho.com/apidoc.html

Use this snippet to create a new custom module record. Ensure all required parameters and UDFs are correctly formatted.

```bash
curl -X POST https://sprintsapi.zoho.com/zsapi/team/6*******4/projects/2348*****52345/modules/531******43253/entity/54235***5234/ \
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3' \
--data-urlencode'name=Sample Record' \
--data-urlencode'owners=["579000000004001"]' \
--data-urlencode'description=' \
--data-urlencode'statusid=65253523623923' \
--data-urlencode'UDF_CHAR1=Sample text' \
--data-urlencode'UDF_DATE1=2017-11-22T16:30:00+05:30' \
--data-urlencode'UDF_DATETIME1=2017-11-22T16:30:00+05:30' \
--data-urlencode'UDF_TEXT1=Text area content' \
--data-urlencode'UDF_LONG1=1' \
--data-urlencode'UDF_PKL1=2000000009049' \
--data-urlencode'UDF_RADIO1=2000000009057' \
--data-urlencode'UDF_MULTIPKL1=["1736000000003109","1736000000003111","1736000000003113"]' \
--data-urlencode'UDF_CHKBOX1=["2000000009069"]' \
--data-urlencode'UDF_DOUBLE1=0.1' \
--data-urlencode'UDF_URI1=https://www.google.com' \
--data-urlencode'UDF_EMAIL1=nicholas@zylker.com' \
--data-urlencode'UDF_BOOLEAN1=2000000009075' \
--data-urlencode'UDF_USERPKL1=2000000009075'
```

```json
{ "failedEntityInfo": {}, successEntityIds: [ "5000000011862" ], status: "success" }
```

--------------------------------

### Get Items

Source: https://sprints.zoho.com/apidoc.html

Fetches the list of all the items associated with a sprint. Note: If Project type is 'Kanban', 'kanbanBoardId' from Get Project Details should be used instead of sprintId.

```APIDOC
## GET {APIEndPoint}/team/{teamId}/projects/{projectId}/sprints/{backlogId|sprintId}/item/

### Description
Fetches the list of all the items associated with a sprint. Note: If Project type is 'Kanban', 'kanbanBoardId' from Get Project Details should be used instead of sprintId.

### Method
GET

### Endpoint
{APIEndPoint}/team/{teamId}/projects/{projectId}/sprints/{backlogId|sprintId}/item/

### Parameters
#### Path Parameters
- **teamId** (string) - Required - The ID of the team.
- **projectId** (string) - Required - The ID of the project.
- **backlogId|sprintId** (string) - Required - The ID of the backlog or sprint.

### Scope
ZohoSprints.items.READ
```

--------------------------------

### Get Extension Timesheet Data

Source: https://sprints.zoho.com/apidoc.html#Overview

Fetch existing extension data for a specific timesheet. This is a GET request to a detailed endpoint including timesheet and extension IDs.

```curl
curl -X GET https://sprintsapi.zoho.com/zsapi/team/7*****4/projects/19091*******7713/timesheet/190910000********/extensions/190910000000*****/data  
-H 'Authorization: Zoho-oauthtoken 1***.f******************************a.6******************************3'
```
Tokens:
Raw