Deliverables

The Deliverables API lets you create, list, update and delete Deliverables in a Workspace.

The Deliverable object

{
  "id": "1",
  "project_id": "1",
  "title": "deliverable.png",
  "is_protected": true,
  "type": "file",
  "size": 10000,
  "url": "https://workspace.kitchen.co/files/file.zip",
  "file": {},
  "created_at": "2021-10-27T11:52:20+00:00"
}
1
2
3
4
5
6
7
8
9
10
11

Attributes

id string

The unique identifier of the Deliverable.


project_id string

The id of the project associated with the Deliverable.


title string

The title of the Deliverable. When the Deliverable type is file, the title is the name of the file.


is_protected bool

Whether the Deliverable is protected by a paywall.


type string

The type of the Deliverable. Can be file or url.


size string|null

The size of the Deliverable. Present when the Deliverable type is file otherwise is null.


url string

The url of the Deliverable.


file File|null

The File associated with the Deliverable. See The File object


created_at datetime

The creation datetime of the Deliverable.




List Deliverables

GET /v1/deliverables

curl 'https://{workspace}.kitchen.co/api/v1/deliverables' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}'
1
2
3

Response

{
  "data": [
    {
      "id": "1",
      "project_id": "1",
      "title": "deliverable.png",
      "is_protected": true,
      "type": "file",
      "size": 10000,
      "url": "https://workspace.kitchen.co/files/…",
      "file": {},
      "created_at": "2021-10-27T11:52:20+00:00"
    },],
  "meta": {}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19



Retrieve a Deliverable

GET /v1/deliverables/{deliverable_id}

curl 'https://{workspace}.kitchen.co/api/v1/deliverables/{deliverable_id}' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}'
1
2
3

Parameters

deliverable_id string required


Response

{
  "id": "1",
  "project_id": "1",
  "title": "deliverable.png",
  "is_protected": true,
  "type": "file",
  "size": 10000,
  "url": "https://workspace.kitchen.co/files/…",
  "file": {},
  "created_at": "2021-10-27T11:52:20+00:00"
}
1
2
3
4
5
6
7
8
9
10
11



Create a Deliverable

POST /v1/deliverables

curl 'https://{workspace}.kitchen.co/api/v1/deliverables' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}' \
 -F 'project_id="1"' \
 -F 'type="file"' \
 -F '[email protected]"deliverable.png"' \
 -F 'is_protected="1"' \
 -X POST
1
2
3
4
5
6
7
8

Body parameters

project_id string required

The id of the Project that will be associated with the Deliverable.


type string required

The type of the Deliverable. Can be file or url.


title string Required if type is url

The title of the Deliverable.


url string Required if type is url

The url of the Deliverable.


file string Required if type is file

The file associated with the Deliverable.


is_protected bool required

Whether the Deliverable should be protected by a paywall.


Response

{
  "id": "1",
  "project_id": "1",
  "title": "deliverable.png",
  "is_protected": true,
  "type": "file",
  "size": 10000,
  "url": "https://workspace.kitchen.co/files/…",
  "file": {},
  "created_at": "2021-10-27T11:52:20+00:00"
}
1
2
3
4
5
6
7
8
9
10
11



Update a Deliverable

POST /v1/deliverables/{deliverable_id}

curl 'https://{workspace}.kitchen.co/api/v1/deliverables/{deliverable_id}' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}' \
 -d 'title=new-deliverable.png' \
 -d 'url=https://some-domain.com/some-file.zip' \
 -X POST
1
2
3
4
5
6

Parameters

deliverable_id string required

The id of the Deliverable.


Body parameters

file string optional

The file that should be associated with the Deliverable. If present the type of the Deliverable will be changed to file.


title string optional

The title of the Deliverable.


is_protected bool optional

Whether the Deliverable should be protected by a paywall.


url string optional

The url of the Deliverable. If present the type of the Deliverable will be changed to url.

Response

{
  "id": "1",
  "project_id": "1",
  "title": "new-deliverable.png",
  "is_protected": true,
  "type": "url",
  "size": 10000,
  "url": "https://some-domain.com/some-file…",
  "file": null,
  "created_at": "2021-10-27T11:52:20+00:00"
}
1
2
3
4
5
6
7
8
9
10
11



Delete a Deliverable

DELETE /v1/deliverables/{deliverable_id}

curl 'https://{workspace}.kitchen.co/api/v1/deliverables/{deliverable_id}' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}' \
 -X DELETE
1
2
3
4

Parameters

deliverable_id string required

The id of the Deliverable.


Response

Status 204 No Content



List Deliverables from a Project

GET /v1/projects/{project_id}/deliverables

curl 'https://{workspace}.kitchen.co/api/v1/projects/{project_id}/deliverables' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}' 
1
2
3

Parameters

project_id string Required

The id of the Project.


Response

{
  "data": [
    {
      "id": "1",
      "project_id": "1",
      "title": "deliverable.png",
      "is_protected": true,
      "type": "file",
      "size": 10000,
      "url": "https://workspace.kitchen.co/files/…",
      "file": {},
      "created_at": "2021-10-27T11:52:20+00:00"
    },]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16