Kitchen API reference

Reminders

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

The Reminder object

{
  "id": "1",
  "title": "Follow up",
  "project_id": "1",
  "assigned_by": {…},
  "assigned_to": {…},
  "scheduled_for": "2021-12-10T09:00:00+00:00",
  "is_activated": false,
  "created_at": "2021-10-28T06:41:25+00:00"
}
1
2
3
4
5
6
7
8
9
10

Attributes

id string

The unique identifier of the Reminder.

title string

The title of the Reminder.

project_id string

The id of the Project associated with the Reminder.

assigned_by User

The User that assigned the Reminder. See The User object.

assigned_to User

The User the Reminder is assigned to. See The User object.

scheduled_for string

The datetime for when the Reminder is scheduled for activation.

is_activated bool

Whether the Reminder has been activated.

created_at datetime

The creation datetime of the Reminder.



List Reminders

GET /v1/reminders

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

Response

{
  "data": [
    {
      "id": "1",
      "title": "Follow up",
      "project_id": "1",
      "assigned_by": {…},
      "assigned_to": {…},
      "scheduled_for": "2021-12-10T09:00:00+00:00",
      "is_activated": false,
      "created_at": "2021-10-28T06:41:25+00:00"
    },
    …
  ],
  "meta": {
    …
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18



Retrieve a Reminder

GET /v1/reminders/{remiinder_id}

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

Parameters

reminder_id string required

The id of the Reminder.

Response

{
  "id": "1",
  "title": "Follow up",
  "project_id": "1",
  "assigned_by": {…},
  "assigned_to": {…},
  "scheduled_for": "2021-12-10T09:00:00+00:00",
  "is_activated": false,
  "created_at": "2021-10-28T06:41:25+00:00"
}
1
2
3
4
5
6
7
8
9
10



Create a Reminder

POST /v1/reminders

curl 'https://{workspace}.kitchen.co/api/v1/reminders' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}' \
 -d 'project_id=1' \
 -d 'title=Follow up' \
 -d 'scheduled_for=2022-12-10 09:00:00' \
 -d 'assignee_id=3' \
 -d 'assigner_id=3' \
 -X POST
1
2
3
4
5
6
7
8
9

Body parameters

project_id string required

The id of the Project that will be assigned to the Reminder.

title string required

The title of the Reminder.

scheduled_for datetime required

The datetime when the Reminder should be activated. Should be GMT 0 timezone.

assignee_id string required

The id of the User the Reminder will be assigned to. Should be a manager user.

assigner_id string required

The id of the User the Reminder will be assigned by. Should be a manager user.

Response

{
  "id": "1",
  "title": "Follow up",
  "project_id": "1",
  "assigned_by": {…},
  "assigned_to": {…},
  "scheduled_for": "2021-12-10T09:00:00+00:00",
  "is_activated": false,
  "created_at": "2021-10-28T06:41:25+00:00"
}
1
2
3
4
5
6
7
8
9
10



Update a Reminder

PUT /v1/reminders/{reminder_id}

curl 'https://{workspace}.kitchen.co/api/v1/reminders/{reminder_id}' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}' \
 -d 'title=Follow up again' \
 -X PUT
1
2
3
4
5

Parameters

reminder_id string required

The id of the Reminder.

Body parameters

title string optional

The new title of the Reminder.

assignee_id string optional

The id of the User the Reminder will be assigned to. Should be a manager user.

scheduled_for datetime optional

The new datetime when the Reminder should be activated.

Response

{
  "id": "1",
  "title": "Follow up again",
  "project_id": "1",
  "assigned_by": {…},
  "assigned_to": {…},
  "scheduled_for": "2021-12-10T09:00:00+00:00",
  "is_activated": false,
  "created_at": "2021-10-28T06:41:25+00:00"
}
1
2
3
4
5
6
7
8
9
10



Delete a Reminder

DELETE /v1/reminders/{reminder_id}

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

Parameters

reminder_id string required

The id of the Reminder.

Response

Status 204 No Content



List Reminders from a Project

GET /v1/projects/{project_id}/reminders

curl 'https://{workspace}.kitchen.co/api/v1/projects/{project_id}/reminders' \
 -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",
      "title": "Follow up",
      "project_id": "1",
      "assigned_by": {…},
      "assigned_to": {…},
      "scheduled_for": "2021-12-10T09:00:00+00:00",
      "is_activated": false,
      "created_at": "2021-10-28T06:41:25+00:00"
    },
    …
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15