Kitchen API reference

Quotes

The Quotes API lets you list Quotes in a Workspace.

The Quote object

{
  "id": "1",
  "name": "Untitled Quote",
  "status": "sent",
  "sent_at": "2021-10-27T15:03:34+00:00",
  "expires_at": "2021-11-10T15:03:34+00:00",
  "voided_at": null,
  "accepted_at": null,
  "updated_at": "2021-10-27T15:03:34+00:00",
  "created_at": "2021-10-27T15:03:25+00:00",
  "delivery_date": null,
  "author": {…},
  "prices": [
      {
          "id": "1",
          "quote_id": "1",
          "name": "standard",
          "price": 10000,
          "currency": "USD",
          "upfront": 0,
          "is_accepted": false,
          "accepted_by": null,
          "accepted_at": null
      },
  ],
  "currency": "USD",
  "project_id": "1",
  "message_id": "1",
  "body": "…",
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

Attributes

id string

Unique identifier of the Quote.

name string

The name of the Quote.

status string

The status of the Quote. Can be draft, sent, accepted, expired or voided.

sent_at datetime|null

The datetime the Quote was created.

expires_at datetime|null

The datetime the Quote expiries.

voided_at datetime|null

The datetime the Quote was voided.

accepted_at datetime|null

The datetime the Quote was accepted.

updated_at datetime

The datetime the Quote was updated.

created_at datetime

The datetime the Quote was created.

delivery_date datetime|null

The delivery datetime of the Quote. Calculated when the quote is accepted.

author User

The author of the Quote. See The User object

prices QuotePriceOption[]

The pricing options of the Quote. See The QuotePriceOption object

currency string

The currency of the Quote.

project_id string|null

The id of the Project associated with the Quote.

message_id string|null

The id of the Message associated with the Quote.

body string

The body of the quote.


The QuotePriceOption object

{
  "id": "1",
  "quote_id": "1",
  "name": "standard",
  "price": 10000,
  "currency": "USD",
  "upfront": 0,
  "is_accepted": false,
  "accepted_by": null,
  "accepted_at": null
},
1
2
3
4
5
6
7
8
9
10
11

id string

The unique identifier of the QuotePriceOption.

quote_id string

The id of the Quote associated with the QuotePriceOption.

name string

The name of the QuotePriceOption.

price float

The price of the QuotePriceOption.

currency string

The currency of the QuotePriceOption.

upfront float

The upfront amount of the QuotePriceOption.

is_accepted bool

Whether the QuotePriceOption is accepted.

accepted_by User|null

The User who accepted the QuotePriceOption.

accepted_at string|null

The datetime the QuotePriceOption was accepted.



List Quotes

GET /v1/quotes

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

Response

{
  "data": [
    {
      "id": "1",
      "name": "Untitled Quote",
      "status": "sent",
      "sent_at": "2021-10-27T15:03:34+00:00",
      "expires_at": "2021-11-10T15:03:34+00:00",
      "voided_at": null,
      "accepted_at": null,
      "updated_at": "2021-10-27T15:03:34+00:00",
      "created_at": "2021-10-27T15:03:25+00:00",
      "delivery_date": null,
      "author": {…},
      "prices": [
          {
              "id": "1",
              "quote_id": "1",
              "name": "standard",
              "price": 10000,
              "currency": "USD",
              "upfront": 0,
              "is_accepted": false,
              "accepted_by": null,
              "accepted_at": null
          },
      ],
      "currency": "USD",
      "project_id": "1",
      "message_id": "1",
      "body": "…",
    }
  ],
  "meta": {
    …
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37



Retrieve a Quote

GET /v1/quotes/{quote_id}

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

Parameters

quote_id string required

Response

{
  "id": "1",
  "name": "Untitled Quote",
  "status": "sent",
  "sent_at": "2021-10-27T15:03:34+00:00",
  "expires_at": "2021-11-10T15:03:34+00:00",
  "voided_at": null,
  "accepted_at": null,
  "updated_at": "2021-10-27T15:03:34+00:00",
  "created_at": "2021-10-27T15:03:25+00:00",
  "delivery_date": null,
  "author": {…},
  "prices": [
      {
          "id": "1",
          "quote_id": "1",
          "name": "standard",
          "price": 10000,
          "currency": "USD",
          "upfront": 0,
          "is_accepted": false,
          "accepted_by": null,
          "accepted_at": null
      },
  ],
  "currency": "USD",
  "project_id": "1",
  "message_id": "1",
  "body": "…",
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30



List Quotes from a Project

GET /v1/projects/{project_id}/quotes

curl 'https://{workspace}.kitchen.co/api/v1/projects/{project_id}/quotes' \
 -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",
      "name": "Untitled Quote",
      "status": "sent",
      "sent_at": "2021-10-27T15:03:34+00:00",
      "expires_at": "2021-11-10T15:03:34+00:00",
      "voided_at": null,
      "accepted_at": null,
      "updated_at": "2021-10-27T15:03:34+00:00",
      "created_at": "2021-10-27T15:03:25+00:00",
      "delivery_date": null,
      "author": {…},
      "prices": [
        {
          "id": "1",
          "quote_id": "1",
          "name": "standard",
          "price": 10000,
          "currency": "USD",
          "upfront": 0,
          "is_accepted": false,
          "accepted_by": null,
          "accepted_at": null
        },
      ],
      "currency": "USD",
      "project_id": "1",
      "message_id": "1",
      "body": "…",
    },
    …
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35