NAV navbar
logo
API Documentation:

Zepel API Documentation

version 1
baseUri https://{subdomain}.zepel.io/api/v1
protocols HTTPS

Introduction

Zepel is the project management tool that lets you plan, track, and ship features together effortlessly.

The Zepel REST-like API (Beta) gives you greater control over your data inside Zepel, so you can build custom integrations and even automate parts of your organization's workflow.

Authentication

The Zepel API uses token-based authentication.To generate an API token, follow the below steps:

  1. On the top-left corner, click on your account name. This usually is the name of your organization.

  2. From the drop-down menu, click on "Account Settings".

  3. From the Account Settings popup, switch to the "API" tab.

  4. Within the API tab, click on the "Create API token" button.


    Once your personal token is generated, copy it and add it to the authorization header in all your API requests.

Attachments

Attachments in Zepel represents any file uploaded to an item. Using this API endpoint you can fetch all the details on an already uploaded attachment.


Get an attachment

GET: /attachments/{attachment_id}

Get the full details of a specific file attached to an item.


URI Parameters

NameDescriptionTypeRequired
attachment_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get an attachment

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/attachments/{attachment_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

attachment 200

{
  "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "file_name": "file.png",
  "size": 135180,
  "user_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "url": "/local_attachments/project_attachments/5b0cc66b-f128-4efb-abec-4100472a2f55/original.png?1573807853",
  "thumbnail_url": "/local_attachments/project_attachments/5b0cc66b-f128-4efb-abec-4100472a2f55/thumb.jpg?1573807853",
  "content_type": "image/png",
  "created_at": "2019-03-21T14:07:57.660Z",
  "updated_at": "2019-11-26T07:15:39.920Z",
  "attached_to": {
    "type": "Comment",
    "id": "a805a3af-c0fa-4f0b-90d2-dda8f3fc5112"
  }
}

Boards

Boards lets you customize Zepel to map to your workflow, so you can move items from one status to another and keep everyone in your team updated. Using this end point, you can get all the details about a specific board and fetch all the statuses within it.


Get a board's information

GET: /boards/{board_id}

Returns all the details about a specific board.


URI Parameters

NameDescriptionTypeRequired
board_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get a board's information

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/boards/{board_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

board 200

{
  "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "name": "Dev Board",
  "created_at": "2019-03-21T14:07:57.660Z",
  "updated_at": "2019-11-26T07:15:39.920Z"
}


List a board's statuses

GET: /boards/{board_id}/statuses

Returns all the statuses from a specific board.


URI Parameters

NameDescriptionTypeRequired
board_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


List a board's statuses

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/boards/{board_id}/statuses" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

statuses 200

[
  {
    "id": "e417846d-13cd-4424-b87c-6724d6a9c7e1",
    "name": "Todo",
    "board_id": "33e7adf2-8e6f-4e33-9954-99373c416c52",
    "category": "Todo",
    "created_at": "2019-10-30T09:12:57.755Z",
    "updated_at": "2019-10-30T09:12:57.755Z"
  },
  {
    "id": "574d8ac9-fcff-4c80-9aad-bea483c630a5",
    "name": "In-Progress",
    "board_id": "33e7adf2-8e6f-4e33-9954-99373c416c52",
    "category": "In Progress",
    "created_at": "2019-10-30T09:12:57.759Z",
    "updated_at": "2019-10-30T09:12:57.759Z"
  },
  {
    "id": "cc067eec-8202-4f83-a462-ca76931c6428",
    "name": "Resolved",
    "board_id": "33e7adf2-8e6f-4e33-9954-99373c416c52",
    "category": "In Progress",
    "created_at": "2019-10-30T09:12:57.762Z",
    "updated_at": "2019-10-30T09:12:57.762Z"
  },
  {
    "id": "12bec9f6-791b-43e3-921f-40bc0effdf09",
    "name": "Done",
    "board_id": "33e7adf2-8e6f-4e33-9954-99373c416c52",
    "category": "Done",
    "created_at": "2019-10-30T09:12:57.764Z",
    "updated_at": "2019-10-30T09:12:57.764Z"
  }
]

Item Comment

Add comments on items to ask questions, share information, or to provide extra information. With comments in Zepel, you can also upload files and mention people to get their attention.


Get all comments

GET: /projects/{project_id}/lists/{list_id}/items/{item_id}/comments

Returns all comments in a specific item.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue
item_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get all comments

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/items/{item_id}/comments" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

comments 200

[
  {
    "id": "a805a3af-c0fa-4f0b-90d2-dda8f3fc5112",
    "description": "Hello World",
    "user_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
    "item_id": "2f40941f-5f7d-4b78-9078-4406a81e1728",
    "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
    "created_at": "2019-11-15T08:51:02.175Z",
    "updated_at": "2019-11-15T08:51:02.175Z",
    "mentioned_ids": [
      "f4735941-d8e1-4be0-b4b9-54929aa07bd7"
    ],
    "attachment_ids": [
      "5b0cc66b-f128-4efb-abec-4100472a2f55"
    ]
  },
  {
    "id": "a805a3af-c0fa-4f0b-90d2-dda8f3fc5112",
    "description": "Hello World",
    "user_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
    "item_id": "2f40941f-5f7d-4b78-9078-4406a81e1728",
    "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
    "created_at": "2019-11-15T08:51:02.175Z",
    "updated_at": "2019-11-15T08:51:02.175Z",
    "mentioned_ids": [
      "f4735941-d8e1-4be0-b4b9-54929aa07bd7"
    ],
    "attachment_ids": [
      "5b0cc66b-f128-4efb-abec-4100472a2f55"
    ]
  }
]

Create an item comment

POST: /projects/{project_id}/lists/{list_id}/items/{item_id}/comments

Adds a comment to a specific item. While creating an item, you can @ mention a user to get their attention and even upload an attachment.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue
item_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be multipart/form-data

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

ID should be in UUID format.

stringfalse
description

Description should be a string

stringtrue
mentioned_ids

To @ mention a user, add mention_ids as an array of UUIDs of members. You can mention only users who are collaborated in the project.

arrayfalse
attachment

The file you want to upload.

filefalse

Possible Responses

200


Create an item comment

CURL EXAMPLE

curl -X POST "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/items/{item_id}/comments" \
	-H "content-type: multipart/form-data" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: multipart/form-data
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

comment 200

{
  "id": "a805a3af-c0fa-4f0b-90d2-dda8f3fc5112",
  "description": "Hello World",
  "user_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "item_id": "2f40941f-5f7d-4b78-9078-4406a81e1728",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
  "created_at": "2019-11-15T08:51:02.175Z",
  "updated_at": "2019-11-15T08:51:02.175Z",
  "mentioned_ids": [
    "f4735941-d8e1-4be0-b4b9-54929aa07bd7"
  ],
  "attachment_ids": [
    "5b0cc66b-f128-4efb-abec-4100472a2f55"
  ]
}

Items

Items in Zepel are the actionable pieces of work that are created inside a List or a Feature. They can be assigned to more than one person, have due dates, estimates, and statuses. An item can be of type - User Story, Task, Subtask, Bug, or Enhancement.


Get all items

GET: /projects/{project_id}/lists/{list_id}/items

Returns all items inside a specified list or feature along with their details.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get all items

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/items" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

items 200

[
  {
    "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
    "title": "Take the user back to their last visited tab inside the dashboard",
    "type": "Story",
    "parent_id": "f470b042-54f1-4fe9-979e-eb709b9a4989",
    "due_date": "2019-12-12T11:43:27.531Z",
    "assignee_ids": [
      "e3735941-d8e1-4be0-b4b9-54929aa07bd7"
    ],
    "is_archived": false,
    "tags": [
      "hashtag1"
    ],
    "updated_at": "2019-11-26T11:43:27.531Z",
    "created_at": "2019-11-26T11:43:15.384Z",
    "status_id": "e417846d-13cd-4424-b87c-6724d6a9c7e1",
    "estimate": 1.1,
    "description": "This is a description",
    "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
    "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "key": "NE-147",
    "requestor_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
    "section_id": "n4535941-d8e1-4be0-b4b9-54929aa07be8"
  },
  {
    "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
    "title": "Use CRON job for sending email alerts for analytics",
    "type": "Subtask",
    "parent_id": "f470b042-54f1-4fe9-979e-eb709b9a4989",
    "due_date": "2019-12-12T11:43:27.531Z",
    "assignee_ids": [
      "e3735941-d8e1-4be0-b4b9-54929aa07bd7"
    ],
    "is_archived": false,
    "tags": [
      "hashtag1"
    ],
    "updated_at": "2019-11-26T11:43:27.531Z",
    "created_at": "2019-11-26T11:43:15.384Z",
    "status_id": "e417846d-13cd-4424-b87c-6724d6a9c7e1",
    "estimate": 2.1,
    "description": "This is a description",
    "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
    "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "key": "NE-147",
    "requestor_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
    "section_id": "n4535941-d8e1-4be0-b4b9-54929aa07be8"
  }
]

Create an item

POST: /projects/{project_id}/lists/{list_id}/items

Creates an item within a specified list or feature. Using this end point, you can assign it to members collaborated in the project, set due dates, estimate, and change its status in a board.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

Item id should be in UUID format.

stringfalse
title

Title should be a string

stringfalse
description

Description should be a string

stringfalse
type

Must be either Story, Task, Subtask, Enhancement, or Bug

stringfalse
assignee_ids

To assign to a user, add assignee_ids as an array of UUIDs of members. You can only assign to users who are collaborated in the project.

arrayfalse
due_date

Due date must be in yyyy-mm-ddThh:mm:ss+zzzz format.

datetimefalse
status_id

To set a status for an item, send status_id as a string.

stringfalse
parent_id

Parent id is required to create a subtask. This field can be null if the item created is not a subtask.

stringfalse
estimate

The estimate value must be between 0.01 and 1000.

numberfalse
section_id

To create an item under a section, send the section_id as a string.

stringfalse
tags

To add a hashtag to an item, send tags as an array.

arrayfalse

Possible Responses

200


Create an item

CURL EXAMPLE

curl -X POST "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/items" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

item 200

{
  "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
  "title": "Take the user back to their last visited tab inside the dashboard",
  "type": "Story",
  "parent_id": "f470b042-54f1-4fe9-979e-eb709b9a4989",
  "due_date": "2019-12-12T11:43:27.531Z",
  "assignee_ids": [
    "e3735941-d8e1-4be0-b4b9-54929aa07bd7"
  ],
  "is_archived": false,
  "tags": [
    "hashtag1"
  ],
  "updated_at": "2019-11-26T11:43:27.531Z",
  "created_at": "2019-11-26T11:43:15.384Z",
  "status_id": "e417846d-13cd-4424-b87c-6724d6a9c7e1",
  "estimate": 1.1,
  "description": "This is a description",
  "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "key": "NE-147",
  "requestor_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "subtask_ids": "z4735941-d8e1-4be0-b4b9-54929aa07bd7",
  "comment_ids": "m7635941-d8e1-4be0-b4b9-54929aa07bd7",
  "attachment_ids": [
    "n4535941-d8e1-4be0-b4b9-54929aa07bd7"
  ],
  "section_id": "n4535941-d8e1-4be0-b4b9-54929aa07be8"
}


Get an item

GET: /projects/{project_id}/lists/{list_id}/items/{item_id}

Returns a particular item within a specified list or feature.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue
item_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get an item

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/items/{item_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

item 200

{
  "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
  "title": "Take the user back to their last visited tab inside the dashboard",
  "type": "Task",
  "parent_id": "f470b042-54f1-4fe9-979e-eb709b9a4989",
  "due_date": "2019-12-12T11:43:27.531Z",
  "assignee_ids": [
    "e3735941-d8e1-4be0-b4b9-54929aa07bd7"
  ],
  "is_archived": false,
  "tags": [
    "hashtag1"
  ],
  "updated_at": "2019-11-26T11:43:27.531Z",
  "created_at": "2019-11-26T11:43:15.384Z",
  "status_id": "e417846d-13cd-4424-b87c-6724d6a9c7e1",
  "estimate": 1.1,
  "description": "This is a description",
  "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "key": "NE-147",
  "requestor_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "subtask_ids": "z4735941-d8e1-4be0-b4b9-54929aa07bd7",
  "comment_ids": "m7635941-d8e1-4be0-b4b9-54929aa07bd7",
  "attachment_ids": [
    "n4535941-d8e1-4be0-b4b9-54929aa07bd7"
  ],
  "section_id": "n4535941-d8e1-4be0-b4b9-54929aa07be8"
}

Update an item

PUT: /projects/{project_id}/lists/{list_id}/items/{item_id}

Updates an existing item that is specified. Only the fields provided in the body block will be updated; any unspecified fields will remain unchanged.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue
item_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

Item id should be in UUID format.

stringfalse
title

Title should be a string

stringfalse
description

Description should be a string

stringfalse
type

Must be either Story, Task, Subtask, Enhancement, or Bug

stringfalse
assignee_ids

To assign to a user, add assignee_ids as an array of UUIDs of members. You can only assign to users who are collaborated in the project.

arrayfalse
due_date

Due date must be in yyyy-mm-ddThh:mm:ss+zzzz format.

datetimefalse
status_id

To set a status for an item, send status_id as a string.

stringfalse
parent_id

Parent id is required to create a subtask. This field can be null if the item created is not a subtask.

stringfalse
estimate

The estimate value must be between 0.01 and 1000.

numberfalse
section_id

To create an item under a section, send the section_id as a string.

stringfalse
tags

To add a hashtag to an item, send tags as an array.

arrayfalse

Possible Responses

200


Update an item

CURL EXAMPLE

curl -X PUT "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/items/{item_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

item 200

{
  "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
  "title": "Take the user back to their last visited tab inside the dashboard",
  "type": "Task",
  "parent_id": "f470b042-54f1-4fe9-979e-eb709b9a4989",
  "due_date": "2019-12-12T11:43:27.531Z",
  "assignee_ids": [
    "e3735941-d8e1-4be0-b4b9-54929aa07bd7"
  ],
  "is_archived": false,
  "tags": [
    "hashtag1"
  ],
  "updated_at": "2019-11-26T11:43:27.531Z",
  "created_at": "2019-11-26T11:43:15.384Z",
  "status_id": "e417846d-13cd-4424-b87c-6724d6a9c7e1",
  "estimate": 1.1,
  "description": "This is a description",
  "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "key": "NE-147",
  "requestor_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "subtask_ids": "z4735941-d8e1-4be0-b4b9-54929aa07bd7",
  "comment_ids": "m7635941-d8e1-4be0-b4b9-54929aa07bd7",
  "attachment_ids": [
    "n4535941-d8e1-4be0-b4b9-54929aa07bd7"
  ],
  "section_id": "n4535941-d8e1-4be0-b4b9-54929aa07be8"
}


Upload item attachment

POST: /projects/{project_id}/lists/{list_id}/items/{item_id}/attachments

Upload a new attachment to a specific item.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue
item_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be multipart/form-data

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

ID should be in UUID format.

stringfalse
attachment

The file you want to upload.

filetrue

Possible Responses

200


Upload item attachment

CURL EXAMPLE

curl -X POST "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/items/{item_id}/attachments" \
	-H "content-type: multipart/form-data" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: multipart/form-data
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

attachment 200

{
  "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "file_name": "file.png",
  "size": 135180,
  "user_id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "url": "/local_attachments/project_attachments/5b0cc66b-f128-4efb-abec-4100472a2f55/original.png?1573807853",
  "thumbnail_url": "/local_attachments/project_attachments/5b0cc66b-f128-4efb-abec-4100472a2f55/thumb.jpg?1573807853",
  "content_type": "image/png",
  "created_at": "2019-03-21T14:07:57.660Z",
  "updated_at": "2019-11-26T07:15:39.920Z",
  "attached_to": {
    "type": "Item",
    "id": "a805a3af-c0fa-4f0b-90d2-dda8f3fc5112"
  }
}

Lists

Lists in Zepel is where all items are housed. There are two types of lists in Zepel - Project List and Feature. A Project List is created by default along with the project and can not be deleted.


Get all lists

GET: /projects/{project_id}/lists

Returns all lists within a project. This will return both the Project List and all Features inside the project.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get all lists

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

lists 200

[
  {
    "id": "93630284-1835-48c1-822e-a0a6e895d7ec",
    "title": "Dashboard",
    "description": "This is a sample project created by Zepel so you can quickly understand how to use Zepel within your team.",
    "created_at": "2019-11-28T09:31:12.418Z",
    "updated_at": "2019-11-28T09:31:12.769Z",
    "type": "Feature",
    "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "default_board_id": "33e7adf2-8e6f-4e33-9954-99373c416c52"
  },
  {
    "id": "646136d5-f77f-41c6-bca3-4d347fe6d54o",
    "title": "Android App List",
    "description": "This is a sample project created by Zepel so you can quickly understand how to use Zepel within your team.",
    "created_at": "2019-11-28T09:31:12.418Z",
    "updated_at": "2019-11-28T09:31:12.769Z",
    "type": "Project List",
    "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "default_board_id": "33e7adf2-8e6f-4e33-9954-99373c416c52"
  }
]

Create a feature

POST: /projects/{project_id}/lists

Creates a list of type Feature within the specified project.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

ID should be in UUID format.

stringfalse
title

Title should be a string and with limit of 70 characters

stringtrue
description

Description should be a string

stringfalse
default_board_id

When you set a default board, all items in this feature will use statuses from this board by default.

stringfalse

Possible Responses

200


Create a feature

CURL EXAMPLE

curl -X POST "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

list 200

{
  "id": "646136d5-f77f-41c6-bca3-4d347fe6d54o",
  "title": "Dashboard",
  "description": "This is a sample project created by Zepel so you can quickly understand how to use Zepel within your team.",
  "created_at": "2019-11-28T09:31:12.418Z",
  "updated_at": "2019-11-28T09:31:12.769Z",
  "type": "Feature",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "default_board_id": "33e7adf2-8e6f-4e33-9954-99373c416c52"
}


Get a list / feature

GET: /projects/{project_id}/lists/{list_id}

Returns all information about a specific list or feature within a project.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get a list / feature

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

list 200

{
  "id": "646136d5-f77f-41c6-bca3-4d347fe6d54o",
  "title": "Android App List",
  "description": "This is a sample project created by Zepel so you can quickly understand how to use Zepel within your team.",
  "created_at": "2019-11-28T09:31:12.418Z",
  "updated_at": "2019-11-28T09:31:12.769Z",
  "type": "Project List",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "default_board_id": "33e7adf2-8e6f-4e33-9954-99373c416c52"
}

Projects

A project is where members of your organization come together to achieve a common goal. Only members collaborated in a project can gain access to a specific project. You can not currently add or remove members from a project via the API.


Get all projects

GET: /projects

Returns all the projects in the account that you have access to. If you are not collaborated in a specific project, you will not be able to access its details.


Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get all projects

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

projects 200

[
  {
    "id": "646136d5-f77f-41c6-bca3-4d347fe6d54o",
    "title": "Web App",
    "description": "This is a sample project created by Zepel so you can quickly understand how to use Zepel within your team.",
    "created_at": "2019-11-28T09:31:12.418Z",
    "updated_at": "2019-11-28T09:31:12.769Z",
    "key": "WAP"
  },
  {
    "id": "646136d5-f77f-41c6-bca3-4d347fe6d54o",
    "title": "Android App",
    "description": "This is a project for Android App",
    "created_at": "2019-11-28T09:31:12.418Z",
    "updated_at": "2019-11-28T09:31:12.769Z",
    "key": "AAP"
  }
]

Create a project

POST: /projects

Creates a new project within your account.


Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

Project ID should be in UUID format.

stringfalse
title

Project title should be a string and with limit of 80 characters

stringtrue
description

Project description should be a string

stringfalse

Possible Responses

200


Create a project

CURL EXAMPLE

curl -X POST "https://{subdomain}.zepel.io/api/v1/projects" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

project 200

{
  "id": "646136d5-f77f-41c6-bca3-4d347fe6d54o",
  "title": "Android App",
  "description": "This is a project for Android App",
  "created_at": "2019-11-28T09:31:12.418Z",
  "updated_at": "2019-11-28T09:31:12.769Z",
  "key": "ERE"
}


Get a project

GET: /projects/{project_id}

Returns all the information about a specific project.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get a project

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

project 200

{
  "id": "646136d5-f77f-41c6-bca3-4d347fe6d54o",
  "title": "Web App",
  "description": "This is a sample project created by Zepel so you can quickly understand how to use Zepel within your team.",
  "created_at": "2019-11-28T09:31:12.418Z",
  "updated_at": "2019-11-28T09:31:12.769Z",
  "key": "WAP"
}


Get all project members

GET: /projects/{project_id}/project_members

Returns details of all members who are collaborated in a project.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get all project members

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/project_members" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

project_members 200

[
  {
    "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
    "project": {
      "id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
      "name": "Android App",
      "description": "This is a project for Android App"
    },
    "users": {
      "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
      "name": "John Doe",
      "username": "johndoe",
      "confirmed_user": true
    },
    "created_at": "2019-03-21T14:07:57.660Z",
    "updated_at": "2019-11-26T07:15:39.920Z"
  },
  {
    "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
    "project": {
      "id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
      "name": "Android App",
      "description": "This is a project for Android App"
    },
    "users": {
      "id": "r4735941-d8e1-4be0-b4b9-54929aa07bd7",
      "name": "Eliza Check",
      "username": "elizacheck",
      "confirmed_user": true
    },
    "created_at": "2019-03-21T14:07:57.660Z",
    "updated_at": "2019-11-26T07:15:39.920Z"
  }
]


Get all project boards

GET: /projects/{project_id}/project_boards

Returns all the boards associated to a specific project along with their details.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get all project boards

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/project_boards" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

project_boards 200

[
  {
    "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
    "project": {
      "id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
      "name": "Android App",
      "description": "This is a project for Android App"
    },
    "boards": {
      "id": "33e7adf2-8e6f-4e33-9954-99373c416c52",
      "name": "Dev Board"
    },
    "created_at": "2019-03-21T14:07:57.660Z",
    "updated_at": "2019-11-26T07:15:39.920Z"
  },
  {
    "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
    "project": {
      "id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
      "name": "Android App",
      "description": "This is a project for Android App"
    },
    "boards": {
      "id": "33e7adf2-8e6f-4e33-9954-99373c416c52",
      "name": "Design Board"
    },
    "created_at": "2019-03-21T14:07:57.660Z",
    "updated_at": "2019-11-26T07:15:39.920Z"
  }
]

Sections

Sections in Zepel allows you to group similar work items inside a list or a feature. You can use it as a subdivision of your feature or list to make it easier to read or to give your team more context.


Get all sections

GET: /projects/{project_id}/lists/{list_id}/sections

Returns all sections within a list or feature along with its details.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get all sections

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/sections" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

sections 200

[
  {
    "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
    "title": "Filters for Image",
    "type": "Section",
    "tags": [
      "hashtag_1"
    ],
    "updated_at": "2019-11-26T11:43:27.531Z",
    "created_at": "2019-11-26T11:43:15.384Z",
    "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
    "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "key": "NE-147",
    "attachment_ids": [
      "n4535941-d8e1-4be0-b4b9-54929aa07bd7"
    ]
  },
  {
    "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
    "title": "Search for images",
    "type": "Section",
    "tags": [
      "hashtag_1"
    ],
    "updated_at": "2019-11-26T11:43:27.531Z",
    "created_at": "2019-11-26T11:43:15.384Z",
    "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
    "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
    "key": "NE-147",
    "attachment_ids": [
      "n4535941-d8e1-4be0-b4b9-54929aa07bd7"
    ]
  }
]

Create a section

POST: /projects/{project_id}/lists/{list_id}/sections

Creates a section within the specified list or feature.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

Section id in UUID format.

stringfalse
title

Title should be a string

stringfalse
description

Description should be a string

stringfalse
tags

To add a hashtag to a section, send tags as an array.

arrayfalse

Possible Responses

200


Create a section

CURL EXAMPLE

curl -X POST "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/sections" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

section 200

{
  "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
  "title": "Filters for Image",
  "type": "Section",
  "tags": [
    "hashtag1"
  ],
  "updated_at": "2019-11-26T11:43:27.531Z",
  "created_at": "2019-11-26T11:43:15.384Z",
  "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "key": "NE-147",
  "attachment_ids": [
    "n4535941-d8e1-4be0-b4b9-54929aa07bd7"
  ]
}


Get a section

GET: /projects/{project_id}/lists/{list_id}/sections/{section_id}

Returns a specific section within a list or feature.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue
section_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get a section

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/sections/{section_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

section 200

{
  "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
  "title": "Filters for Image",
  "type": "Section",
  "tags": [
    "hashtag1"
  ],
  "updated_at": "2019-11-26T11:43:27.531Z",
  "created_at": "2019-11-26T11:43:15.384Z",
  "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "key": "NE-147",
  "attachment_ids": [
    "n4535941-d8e1-4be0-b4b9-54929aa07bd7"
  ]
}

Update a section

PUT: /projects/{project_id}/lists/{list_id}/sections/{section_id}

Updates a particular section within the specified list or feature.


URI Parameters

NameDescriptionTypeRequired
project_idstringtrue
list_idstringtrue
section_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

Section id in UUID format.

stringfalse
title

Title should be a string

stringfalse
description

Description should be a string

stringfalse
tags

To add a hashtag to a section, send tags as an array.

arrayfalse

Possible Responses

200


Update a section

CURL EXAMPLE

curl -X PUT "https://{subdomain}.zepel.io/api/v1/projects/{project_id}/lists/{list_id}/sections/{section_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

section 200

{
  "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
  "title": "Filters for Image",
  "type": "Section",
  "tags": [
    "hashtag1"
  ],
  "updated_at": "2019-11-26T11:43:27.531Z",
  "created_at": "2019-11-26T11:43:15.384Z",
  "list_id": "cfc40d7e-35a4-4ac1-916f-2c929e19fce7",
  "project_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "squad_id": "3fe0aaee-de05-4fe3-9056-b5720b84f4e4",
  "key": "NE-147",
  "attachment_ids": [
    "n4535941-d8e1-4be0-b4b9-54929aa07bd7"
  ]
}

Users

Users in Zepel are all the members who are part of your Zepel account. Using this API endpoint, you can get all the details about a specific member.


Get user information

GET: /users/{user_id}

Returns all the information about a specific user in the account.


URI Parameters

NameDescriptionTypeRequired
user_idstringtrue

Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Possible Responses

200


Get user information

CURL EXAMPLE

curl -X GET "https://{subdomain}.zepel.io/api/v1/users/{user_id}" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3"

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

user 200

{
  "id": "e3735941-d8e1-4be0-b4b9-54929aa07bd7",
  "name": "John Doe",
  "username": "johndoe",
  "first_name": "John",
  "last_name": "Doe",
  "confirmed_user": true,
  "created_at": "2019-03-21T14:07:57.660Z",
  "updated_at": "2019-11-26T07:15:39.920Z"
}

Streams

Streams in Zepel allows you to group customer requests from multiple sources, prioritize them, and delegate them to corresponding squads to build customer-centric software.


Create New Request

POST: /streams/requests

Post customer requests gathered from multiple sources in Zepel.


Header Parameters

NameDescriptionTypeRequired
content-type

Should be application/json

stringtrue
authorization

Should be with Bearer Token

stringtrue

Body Parameters

NameDescriptionTypeRequired
id

ID should be in UUID format.

stringfalse
title

Either title or description must be added

stringfalse
description

Either title or description must be added

stringfalse
request_link

Either title or description must be added

stringfalse
requestor

name - Name of the person. Must be in string format

email - email of the person requesting. Must be in string format.

objectfalse

Possible Responses

200


Create New Request

CURL EXAMPLE

curl -X POST "https://{subdomain}.zepel.io/api/v1/streams/requests" \
	-H "content-type: application/json" \
	-H "authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3" \
	-d @request_body

REQUEST HEADERS

content-type: application/json
authorization: Bearer 82c312bdd5c3627327005bceb0b5b88afea4862a249e735611251f2a11e9c9b3

RESPONSE BODY

request 200

{
  "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
  "title": "A webapp extension",
  "description": "Requesting for a Google Chrome extension for the web app",
  "request_link": "https://acmecorp.canny.io/admin/board/feature-requests/p/a-webapp-extension",
  "created_at": "2019-03-21T14:07:57.660Z",
  "requestors": {
    "id": "3669ab41-09ee-47f0-98ad-ccc12e6d9fcc",
    "name": "John Doe",
    "email": "john@doe.com",
    "created_at": "2019-03-21T14:07:57.660Z"
  }
}