{"id":22281383,"url":"https://github.com/plone/plone.restapi","last_synced_at":"2025-05-15T11:02:56.216Z","repository":{"id":16422137,"uuid":"19173345","full_name":"plone/plone.restapi","owner":"plone","description":"RESTful API for Plone.","archived":false,"fork":false,"pushed_at":"2025-05-13T10:48:47.000Z","size":47584,"stargazers_count":96,"open_issues_count":225,"forks_count":87,"subscribers_count":189,"default_branch":"main","last_synced_at":"2025-05-15T11:02:15.459Z","etag":null,"topics":["hypermedia-api","plone","python","rest","rest-api"],"latest_commit_sha":null,"homepage":"http://plonerestapi.readthedocs.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/plone.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"plone"}},"created_at":"2014-04-26T08:59:40.000Z","updated_at":"2025-05-12T18:25:08.000Z","dependencies_parsed_at":"2023-09-21T18:32:28.798Z","dependency_job_id":"f8ce9f21-c91e-4111-b503-e441eb65f811","html_url":"https://github.com/plone/plone.restapi","commit_stats":{"total_commits":2958,"total_committers":99,"mean_commits":29.87878787878788,"dds":0.7582826233941853,"last_synced_commit":"fae3744db70803ecfcaf473bbf021d7a91b4b08c"},"previous_names":[],"tags_count":275,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plone%2Fplone.restapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plone%2Fplone.restapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plone%2Fplone.restapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plone%2Fplone.restapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plone","download_url":"https://codeload.github.com/plone/plone.restapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254328385,"owners_count":22052632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hypermedia-api","plone","python","rest","rest-api"],"created_at":"2024-12-03T16:17:41.069Z","updated_at":"2025-05-15T11:02:56.206Z","avatar_url":"https://github.com/plone.png","language":"Python","readme":"[![image](https://github.com/plone/plone.restapi/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/plone/plone.restapi/actions/workflows/tests.yml)\n\n[![image](https://coveralls.io/repos/github/plone/plone.restapi/badge.svg?branch=main)](https://coveralls.io/github/plone/plone.restapi?branch=main)\n\n[![image](https://readthedocs.org/projects/pip/badge)](https://plonerestapi.readthedocs.io/en/latest/)\n\n[![image](https://img.shields.io/pypi/v/plone.restapi.svg)](https://pypi.org/project/plone.restapi/)\n\n# Introduction\n\n`plone.restapi` is a RESTful hypermedia API for Plone.\n\n# Documentation\n\n\u003chttps://plonerestapi.readthedocs.io/en/latest/\u003e\n\n# Getting started\n\nA live demo of Plone 6 with the latest `plone.restapi` release is\navailable at:\n\n\u003chttps://demo.plone.org/\u003e\n\nAn example GET request on the portal root is the following.\n\n```shell\ncurl -i https://demo.plone.org/++api++ -H \"Accept: application/json\"\n```\n\nAn example POST request to create a new document is the following.\n\n```shell\ncurl -i -X POST https://demo.plone.org/++api++ \\\n    -H \"Accept: application/json\" \\\n    -H \"Content-Type: application/json\" \\\n    --data-raw '{\"@type\": \"Document\", \"title\": \"My Document\"}' \\\n    --user admin:admin\n```\n\n\u003e [!NOTE]  \n\u003e You will need some kind of API browser application to explore the API.\n\u003e You will also need to first obtain a basic authorization token.\n\u003e We recommend using [Postman](https://www.postman.com/) which makes it\n\u003e easier to obtain a basic authorization token.\n\n# Installation\n\n`plone.restapi` is included in Plone 6 if you install the `Plone` package.\n\nIf it is not installed, add it using requirements.txt or as a dependency of another package.\n\n# Python / Plone Compatibility\n\nplone.restapi 9 requires Python 3 and works with Plone 5.2 and Plone\n6.x.\n\nplone.restapi 8 entered \"maintenance\" mode with the release of\nplone.restapi 9 (September 2023). It is not planned to backport any\nfeatures to this version and we highly recommend to upgrade to\nplone.restapi 9.\n\nPython versions that reached their\n[end-of-life](https://devguide.python.org/versions/), including Python\n3.6 and Python 3.7, are not supported any longer.\n\nUse plone.restapi 7 if you are running Python 2.7 or Plone versions\nbelow 5.2.\n\n# Contribute\n\n- Issue Tracker: \u003chttps://github.com/plone/plone.restapi/issues\u003e\n- Source Code: \u003chttps://github.com/plone/plone.restapi\u003e\n- Documentation: \u003chttps://plonerestapi.readthedocs.io/en/latest\u003e\n\n# Examples\n\n`plone.restapi` has been used in production since its first alpha\nrelease. It can be seen in action at the following sites:\n\n- Zeelandia GmbH \u0026 Co. KG: \u003chttps://www.zeelandia.de\u003e (by kitconcept\n  GmbH)\n- VHS-Ehrenamtsportal: \u003chttps://vhs-ehrenamtsportal.de\u003e (by kitconcept\n  GmbH)\n- German Physical Society: \u003chttps://www.dpg-physik.de\u003e (by kitconcept\n  GmbH)\n\n# Support\n\nIf you are having issues, please let us know via the [issue\ntracker](https://github.com/plone/plone.restapi/issues).\n\nIf you require professional support, here is a list of Plone solution\nproviders that contributed significantly to `plone.restapi` in the past.\n\n- [kitconcept GmbH](https://kitconcept.com) (Germany)\n- [4teamwork](https://www.4teamwork.ch/en) (Switzerland)\n- [CodeSyntax](https://www.codesyntax.com/en) (Spain)\n\n# License\n\nThe project is licensed under the GPLv2.\n","funding_links":["https://github.com/sponsors/plone"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplone%2Fplone.restapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplone%2Fplone.restapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplone%2Fplone.restapi/lists"}