API Documentation

API Endpoint

Deleted Items

Deleted Items

The Deleted item object represents an deleted object (e.g., Task, Project, Doc) that can be found in the Recycle bin.

Deleted items can be restored, meaning the object they reference will be restored and it will disappear from the Recycle bin. They can also be permanently deleted, meaning the object they reference will no longer be able to be retrieved from the Recycle bin.

You can find out more about Recycle bin in our Help documentation for Recycle bin

Supported filter params

  • id

  • item_type

  • deleter_id

  • name

  • location

  • created_at (date)

Supported item types

  • project

  • deal

  • budget

  • invoice

  • task

GET /api/v2/deleted_items
Requestsreturns deleted_itemsreturns project deleted_itemsreturns project deleted_itemsreturns project deleted_itemsreturns project deleted_itemsreturns project deleted_itemsreturns project deleted_itemsreturns dashboard deleted_itemsreturns time_entry deleted_itemsreturns purchase_order deleted_items

GET  /api/v2/deleted_items

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "8",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:52.023+02:00",
        "deleter_id": 1262,
        "item_id": 241,
        "item_type": "project",
        "location": "My organization",
        "name": "test project",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "9",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:52.118+02:00",
        "deleter_id": 1264,
        "item_id": 301,
        "item_type": "deal",
        "location": "Company: Client558",
        "name": "test name",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "10",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:52.304+02:00",
        "deleter_id": 1267,
        "item_id": 302,
        "item_type": "budget",
        "location": "Project: test project",
        "name": "test name",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "11",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:52.359+02:00",
        "deleter_id": 1268,
        "item_id": 2,
        "item_type": "invoice",
        "location": "Company: Client561",
        "name": "Invoice - 2016/01",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "12",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:52.791+02:00",
        "deleter_id": 1274,
        "item_id": 31,
        "item_type": "task",
        "location": "Project: test project",
        "name": "Ticket title",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "13",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:53.006+02:00",
        "deleter_id": 1276,
        "item_id": 181,
        "item_type": "service",
        "location": "test name",
        "name": "test name",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "14",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:53.115+02:00",
        "deleter_id": 1278,
        "item_id": 21,
        "item_type": "dashboard",
        "location": "My organization",
        "name": "Dashboard q",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "15",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:53.481+02:00",
        "deleter_id": 1282,
        "item_id": 6,
        "item_type": "time_entry",
        "location": "test project / test name / test name",
        "name": "name surname - Apr 19 2024 - 08:00",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "16",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:53.622+02:00",
        "deleter_id": 1284,
        "item_id": 9,
        "item_type": "purchase_order",
        "location": "Budget: test name",
        "name": "Purchase Order",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "370"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 9,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=project

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "17",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:53.850+02:00",
        "deleter_id": 1287,
        "item_id": 247,
        "item_type": "project",
        "location": "My organization",
        "name": "test project",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "371"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=project&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=project&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=deal

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "27",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:55.480+02:00",
        "deleter_id": 1314,
        "item_id": 311,
        "item_type": "deal",
        "location": "Company: Client584",
        "name": "test name",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "372"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=deal&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=deal&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=budget

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "37",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:57.302+02:00",
        "deleter_id": 1342,
        "item_id": 317,
        "item_type": "budget",
        "location": "Project: test project",
        "name": "test name",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "373"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=budget&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=budget&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=invoice

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "47",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:04:59.311+02:00",
        "deleter_id": 1368,
        "item_id": 6,
        "item_type": "invoice",
        "location": "Company: Client613",
        "name": "Invoice - 2016/01",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "374"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=invoice&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=invoice&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=task

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "57",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:05:01.384+02:00",
        "deleter_id": 1399,
        "item_id": 36,
        "item_type": "task",
        "location": "Project: test project",
        "name": "Ticket title",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "375"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=task&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=task&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=service

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "67",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:05:03.177+02:00",
        "deleter_id": 1426,
        "item_id": 193,
        "item_type": "service",
        "location": "test name",
        "name": "test name",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "376"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=service&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=service&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=dashboard

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "77",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:05:04.927+02:00",
        "deleter_id": 1453,
        "item_id": 28,
        "item_type": "dashboard",
        "location": "My organization",
        "name": "Dashboard x",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "377"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=dashboard&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=dashboard&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=time_entry

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "87",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:05:07.094+02:00",
        "deleter_id": 1482,
        "item_id": 14,
        "item_type": "time_entry",
        "location": "test project / test name / test name",
        "name": "name surname - Apr 19 2024 - 08:00",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "378"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=time_entry&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=time_entry&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/deleted_items?filter[item_type]=purchase_order

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "97",
      "type": "deleted_items",
      "attributes": {
        "created_at": "2024-04-19T06:05:08.857+02:00",
        "deleter_id": 1509,
        "item_id": 18,
        "item_type": "purchase_order",
        "location": "Budget: test name",
        "name": "Purchase Order",
        "private": false,
        "recovered_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "379"
          }
        },
        "deleter": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=purchase_order&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deleted_items?filter%5Bitem_type%5D=purchase_order&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get deleted items
GET/api/v2/deleted_items

GET /api/v2/deleted_items/1
Requestsreturns deleted item

GET  /api/v2/deleted_items/98

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "98",
    "type": "deleted_items",
    "attributes": {
      "created_at": "2024-04-19T06:05:09.069+02:00",
      "deleter_id": 1512,
      "item_id": 301,
      "item_type": "project",
      "location": "My organization",
      "name": "deleted project",
      "private": false,
      "recovered_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "380"
        }
      },
      "deleter": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a deleted item
GET/api/v2/deleted_items/{id}

URI Parameters
HideShow
id
number (required) Example: 1

deleted item id

PATCH /api/v2/deleted_items/1/restore
Requestsrestores projectrestores dealrestores budgetrestores invoicerestores taskrestores servicerestores pagerestores dashboardrestores time_entryrestores purchase_order

PATCH  /api/v2/deleted_items/99/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "302",
    "type": "projects",
    "attributes": {
      "name": "test project",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:05:09.000+02:00",
      "public_access": true,
      "time_on_tasks": false,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:05:09.196+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "381"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/100/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "351",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2024-04-19",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": false,
      "sales_status_id": 1,
      "sales_status_updated_at": null,
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "1a8696895849981af36547ce117a3f35",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": null,
      "rounding_interval_id": null,
      "rounding_method_id": null,
      "billable_time": 0,
      "budget_warning": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2024-04-19T06:05:09.000+02:00",
      "deleted_at": null,
      "created_at": "2024-04-19T06:05:09.508+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2024-04-19",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "382"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "memberships": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/101/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "352",
    "type": "deals",
    "attributes": {
      "name": "test name",
      "date": "2024-04-19",
      "end_date": null,
      "number": "1",
      "deal_number": "1",
      "suffix": null,
      "time_approval": true,
      "expense_approval": true,
      "client_access": false,
      "deal_type_id": 2,
      "budget": true,
      "sales_status_id": null,
      "sales_status_updated_at": null,
      "tag_list": [],
      "origin_deal_id": null,
      "profit_margin": 0,
      "email_key": "e2f166f2520c9a93bf4ff64c01e468e5",
      "purchase_order_number": null,
      "custom_fields": null,
      "position": 1,
      "service_type_restricted_tracking": false,
      "tracking_type_id": 1,
      "editor_config": {},
      "discount": null,
      "man_day_minutes": null,
      "rounding_interval_id": null,
      "rounding_method_id": null,
      "billable_time": 0,
      "budget_warning": null,
      "unapproved_entries_count": 0,
      "rejected_entries_count": 0,
      "estimated_time": 0,
      "budgeted_time": 0,
      "worked_time": 0,
      "time_to_close": null,
      "probability": 50,
      "note_interpolated": null,
      "todo_count": 0,
      "todo_due_date": null,
      "note": null,
      "lost_comment": null,
      "closed_at": null,
      "delivered_on": null,
      "last_activity_at": "2024-04-19T06:05:09.000+02:00",
      "deleted_at": null,
      "created_at": "2024-04-19T06:05:09.924+02:00",
      "sales_closed_at": null,
      "exchange_rate": "1.25",
      "exchange_date": "2024-04-19",
      "sales_closed_on": null,
      "sample_data": false,
      "external_id": null,
      "external_sync": false,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "revenue": 0,
      "revenue_default": 0,
      "revenue_normalized": 0,
      "services_revenue": 0,
      "services_revenue_default": 0,
      "services_revenue_normalized": 0,
      "budget_total": 0,
      "budget_total_default": 0,
      "budget_total_normalized": 0,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "projected_revenue": 0,
      "projected_revenue_default": 0,
      "projected_revenue_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "profit": 0,
      "profit_default": 0,
      "profit_normalized": 0,
      "invoiced": 0,
      "invoiced_default": 0,
      "invoiced_normalized": 0,
      "pending_invoicing": 0,
      "pending_invoicing_default": 0,
      "pending_invoicing_normalized": 0,
      "draft_invoiced": 0,
      "draft_invoiced_default": 0,
      "draft_invoiced_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "expense": 0,
      "expense_default": 0,
      "expense_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "383"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "responsible": {
        "meta": {
          "included": false
        }
      },
      "deal_status": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "lost_reason": {
        "meta": {
          "included": false
        }
      },
      "contract": {
        "meta": {
          "included": false
        }
      },
      "contact": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "template": {
        "meta": {
          "included": false
        }
      },
      "tax_rate": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "memberships": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/102/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "12",
    "type": "invoices",
    "attributes": {
      "number": null,
      "subject": null,
      "invoiced_on": "2024-04-19",
      "sent_on": null,
      "pay_on": "2024-04-29",
      "delivery_on": null,
      "paid_on": null,
      "finalized_on": null,
      "discount": null,
      "tax1_name": null,
      "tax1_value": null,
      "tax2_name": null,
      "tax2_value": null,
      "deleted_at": null,
      "tag_list": [],
      "note": null,
      "exported": false,
      "exported_at": null,
      "export_integration_type_id": null,
      "export_id": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "note_interpolated": null,
      "email_key": "c985f13b1fdf6b76c0e9478629ddba00",
      "purchase_order_number": null,
      "created_at": "2024-04-19T06:05:10.158+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2024-04-19",
      "custom_fields": null,
      "updated_at": "2024-04-19T06:05:10.244+02:00",
      "sample_data": false,
      "pay_on_relative": false,
      "invoice_type_id": 1,
      "credited": false,
      "line_item_tax": false,
      "last_activity_at": "2024-04-19T06:05:10.158+02:00",
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "amount": 0,
      "amount_default": 0,
      "amount_normalized": 0,
      "amount_tax": 0,
      "amount_tax_default": 0,
      "amount_tax_normalized": 0,
      "amount_with_tax": 0,
      "amount_with_tax_default": 0,
      "amount_with_tax_normalized": 0,
      "amount_paid": 0,
      "amount_paid_default": 0,
      "amount_paid_normalized": 0,
      "amount_written_off": 0,
      "amount_written_off_default": 0,
      "amount_written_off_normalized": 0,
      "amount_unpaid": 0,
      "amount_unpaid_default": 0,
      "amount_unpaid_normalized": 0,
      "amount_credited": 0,
      "amount_credited_default": 0,
      "amount_credited_normalized": 0,
      "amount_credited_with_tax": 0,
      "amount_credited_with_tax_default": 0,
      "amount_credited_with_tax_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "384"
        }
      },
      "bill_to": {
        "meta": {
          "included": false
        }
      },
      "bill_from": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "parent_invoice": {
        "meta": {
          "included": false
        }
      },
      "invoice_attributions": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "attachment": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/103/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "41",
    "type": "tasks",
    "attributes": {
      "title": "Ticket title",
      "description": null,
      "number": "1",
      "task_number": "1",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2024-04-19T06:05:11.031+02:00",
      "updated_at": "2024-04-19T06:05:11.134+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "e40729724ab530767b780ca1602d21d5",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": [],
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2024-04-19T06:05:11.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "385"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/104/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "201",
    "type": "services",
    "attributes": {
      "name": "test name",
      "position": 1,
      "deleted_at": null,
      "billable": true,
      "description": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "origin_service_id": null,
      "initial_service_id": 201,
      "budget_cap_enabled": false,
      "editor_config": {},
      "pricing_type_id": 1,
      "billing_type_id": 1,
      "unapproved_time": 0,
      "worked_time": 0,
      "billable_time": 0,
      "estimated_time": null,
      "budgeted_time": null,
      "profit_margin": "100.0",
      "booked_time": 0,
      "unit_id": 2,
      "future_booked_time": 0,
      "markup": null,
      "discount": null,
      "quantity": "1.0",
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "profit": 100000,
      "profit_default": 125000,
      "profit_normalized": 100000,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "future_cost": 0,
      "future_cost_default": 0,
      "future_cost_normalized": 0,
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "price": 100000,
      "price_default": 125000,
      "price_normalized": 100000,
      "revenue": 100000,
      "revenue_default": 125000,
      "revenue_normalized": 100000,
      "projected_revenue": 50000,
      "projected_revenue_default": 62500,
      "projected_revenue_normalized": 50000,
      "expense_amount": 0,
      "expense_amount_default": 0,
      "expense_amount_normalized": 0,
      "expense_billable_amount": 0,
      "expense_billable_amount_default": 0,
      "expense_billable_amount_normalized": 0,
      "budget_total": 100000,
      "budget_total_default": 125000,
      "budget_total_normalized": 100000,
      "budget_used": 0,
      "budget_used_default": 0,
      "budget_used_normalized": 0,
      "future_revenue": 0,
      "future_revenue_default": 0,
      "future_revenue_normalized": 0,
      "future_budget_used": 0,
      "future_budget_used_default": 0,
      "future_budget_used_normalized": 0,
      "discount_amount": 0,
      "discount_amount_default": 0,
      "discount_amount_normalized": 0,
      "markup_amount": 0,
      "markup_amount_default": 0,
      "markup_amount_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "386"
        }
      },
      "service_type": {
        "meta": {
          "included": false
        }
      },
      "deal": {
        "meta": {
          "included": false
        }
      },
      "person": {
        "meta": {
          "included": false
        }
      },
      "section": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/106/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2024-04-19T06:05:12.226+02:00",
      "edited_at": null,
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Page title 1",
      "updated_at": "2024-04-19T06:05:12.507+02:00",
      "version_number": null,
      "last_activity_at": "2024-04-19T06:05:12.226+02:00",
      "body": "{\"text\":\"Page body 1\"}",
      "parent_page_id": null,
      "root_page_id": null,
      "public_uuid": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "388"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "memberships": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/107/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "31",
    "type": "dashboards",
    "attributes": {
      "name": "Dashboard aa",
      "created_at": "2024-04-19T06:05:12.788+02:00",
      "updated_at": "2024-04-19T06:05:12.979+02:00"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "389"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/108/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "16",
    "type": "time_entries",
    "attributes": {
      "date": "2024-04-19",
      "created_at": "2024-04-19T06:05:13.440+02:00",
      "time": 480,
      "billable_time": 480,
      "note": "test note",
      "track_method_id": 1,
      "started_at": null,
      "timer_started_at": null,
      "timer_stopped_at": null,
      "approved": false,
      "approved_at": null,
      "updated_at": "2024-04-19T06:05:13.627+02:00",
      "calendar_event_id": null,
      "invoice_attribution_id": null,
      "invoiced": false,
      "overhead": false,
      "rejected": false,
      "rejected_reason": null,
      "rejected_at": null,
      "last_activity_at": "2024-04-19T06:05:13.441+02:00",
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "cost": 0,
      "cost_default": 0,
      "cost_normalized": 0,
      "work_cost": 0,
      "work_cost_default": 0,
      "work_cost_normalized": 0,
      "overhead_cost": 0,
      "overhead_cost_default": 0,
      "overhead_cost_normalized": 0,
      "internal_overhead_cost": 0,
      "internal_overhead_cost_default": 0,
      "internal_overhead_cost_normalized": 0,
      "facility_overhead_cost": 0,
      "facility_overhead_cost_default": 0,
      "facility_overhead_cost_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "390"
        }
      },
      "person": {
        "meta": {
          "included": false
        }
      },
      "service": {
        "meta": {
          "included": false
        }
      },
      "task": {
        "meta": {
          "included": false
        }
      },
      "approver": {
        "meta": {
          "included": false
        }
      },
      "updater": {
        "meta": {
          "included": false
        }
      },
      "rejecter": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deleted_items/109/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "19",
    "type": "purchase_orders",
    "attributes": {
      "subject": null,
      "status_id": null,
      "issued_on": "2024-04-19",
      "delivery_on": null,
      "sent_on": null,
      "received_on": null,
      "created_at": "2024-04-19T06:05:13.869+02:00",
      "number": "1",
      "note": null,
      "note_interpolated": null,
      "email_key": "d3ea011fd4fdd04b094ff1cf9b2a600b",
      "payment_status_id": 3,
      "exchange_rate": "1.25",
      "exchange_date": "2024-04-19",
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "total_cost": 0,
      "total_cost_default": 0,
      "total_cost_normalized": 0,
      "total_received": 0,
      "total_received_default": 0,
      "total_received_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "391"
        }
      },
      "vendor": {
        "meta": {
          "included": false
        }
      },
      "deal": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "document_type": {
        "meta": {
          "included": false
        }
      },
      "attachment": {
        "meta": {
          "included": false
        }
      },
      "bill_to": {
        "meta": {
          "included": false
        }
      },
      "bill_from": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Restores deleted object
PATCH/api/v2/deleted_items/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

deleted item id

Generated by aglio on 19 Apr 2024