Etherpad API
Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on…
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on your server, under your control.
Endpoints 96
pad
- GETappends a chat message
/appendChatMessage?padID=string&text=string&authorID=string&time=string - POSTappends a chat message
/appendChatMessage?padID=string&text=string&authorID=string&time=string - GETreturns ok when the current api token is valid
/checkToken - POSTreturns ok when the current api token is valid
/checkToken - GETcreateDiffHTMLUsingGET
/createDiffHTML?padID=string&startRev=string&endRev=string - POSTcreateDiffHTMLUsingPOST
/createDiffHTML?padID=string&startRev=string&endRev=string - GETcreatePadUsingGET
/createPad?padID=string&text=stringcreates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad - POSTcreatePadUsingPOST
/createPad?padID=string&text=stringcreates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad - GETdeletes a pad
/deletePad?padID=string - POSTdeletes a pad
/deletePad?padID=string - GETreturns the chatHead (chat-message) of the pad
/getChatHead?padID=string - POSTreturns the chatHead (chat-message) of the pad
/getChatHead?padID=string - GETreturns the chat history
/getChatHistory?padID=string&start=string&end=string - POSTreturns the chat history
/getChatHistory?padID=string&start=string&end=string - GETreturns the text of a pad formatted as HTML
/getHTML?padID=string&rev=string - POSTreturns the text of a pad formatted as HTML
/getHTML?padID=string&rev=string - GETreturns the timestamp of the last revision of the pad
/getLastEdited?padID=string - POSTreturns the timestamp of the last revision of the pad
/getLastEdited?padID=string - GETreturn true of false
/getPublicStatus?padID=string - POSTreturn true of false
/getPublicStatus?padID=string - GETreturns the read only link of a pad
/getReadOnlyID?padID=string - POSTreturns the read only link of a pad
/getReadOnlyID?padID=string - GETreturns the number of revisions of this pad
/getRevisionsCount?padID=string - POSTreturns the number of revisions of this pad
/getRevisionsCount?padID=string - GETreturns the text of a pad
/getText?padID=string&rev=string - POSTreturns the text of a pad
/getText?padID=string&rev=string - GETlist all the pads
/listAllPads - POSTlist all the pads
/listAllPads - GETreturns an array of authors who contributed to this pad
/listAuthorsOfPad?padID=string - POSTreturns an array of authors who contributed to this pad
/listAuthorsOfPad?padID=string - GETreturns the list of users that are currently editing this pad
/padUsers?padID=string - POSTreturns the list of users that are currently editing this pad
/padUsers?padID=string - GETreturns the number of user that are currently editing this pad
/padUsersCount?padID=string - POSTreturns the number of user that are currently editing this pad
/padUsersCount?padID=string - GETsends a custom message of type msg to the pad
/sendClientsMessage?padID=string&msg=string - POSTsends a custom message of type msg to the pad
/sendClientsMessage?padID=string&msg=string - GETsets the text of a pad with HTML
/setHTML?padID=string&html=string - POSTsets the text of a pad with HTML
/setHTML?padID=string&html=string - GETsets a boolean for the public status of a pad
/setPublicStatus?padID=string&publicStatus=string - POSTsets a boolean for the public status of a pad
/setPublicStatus?padID=string&publicStatus=string - GETsets the text of a pad
/setText?padID=string&text=string - POSTsets the text of a pad
/setText?padID=string&text=string
author
- GETcreates a new author
/createAuthor?name=string - POSTcreates a new author
/createAuthor?name=string - GETthis functions helps you to map your application author ids to Etherpad author ids
/createAuthorIfNotExistsFor?authorMapper=string&name=string - POSTthis functions helps you to map your application author ids to Etherpad author ids
/createAuthorIfNotExistsFor?authorMapper=string&name=string - GETReturns the Author Name of the author
/getAuthorName?authorID=string - POSTReturns the Author Name of the author
/getAuthorName?authorID=string - GETreturns an array of all pads this author contributed to
/listPadsOfAuthor?authorID=string - POSTreturns an array of all pads this author contributed to
/listPadsOfAuthor?authorID=string - GETreturns all sessions of an author
/listSessionsOfAuthor?authorID=string - POSTreturns all sessions of an author
/listSessionsOfAuthor?authorID=string
group
- GETcreates a new group
/createGroup - POSTcreates a new group
/createGroup - GETthis functions helps you to map your application group ids to Etherpad group ids
/createGroupIfNotExistsFor?groupMapper=string - POSTthis functions helps you to map your application group ids to Etherpad group ids
/createGroupIfNotExistsFor?groupMapper=string - GETcreates a new pad in this group
/createGroupPad?groupID=string&padName=string&text=string - POSTcreates a new pad in this group
/createGroupPad?groupID=string&padName=string&text=string - GETdeletes a group
/deleteGroup?groupID=string - POSTdeletes a group
/deleteGroup?groupID=string - GETlistAllGroupsUsingGET
/listAllGroups - POSTlistAllGroupsUsingPOST
/listAllGroups - GETreturns all pads of this group
/listPads?groupID=string - POSTreturns all pads of this group
/listPads?groupID=string - GETlistSessionsOfGroupUsingGET
/listSessionsOfGroup?groupID=string - POSTlistSessionsOfGroupUsingPOST
/listSessionsOfGroup?groupID=string
session
- GETcreates a new session. validUntil is an unix timestamp in seconds
/createSession?groupID=string&authorID=string&validUntil=string - POSTcreates a new session. validUntil is an unix timestamp in seconds
/createSession?groupID=string&authorID=string&validUntil=string - GETdeletes a session
/deleteSession?sessionID=string - POSTdeletes a session
/deleteSession?sessionID=string - GETreturns informations about a session
/getSessionInfo?sessionID=string - POSTreturns informations about a session
/getSessionInfo?sessionID=string
- GETappendTextUsingGET
/appendText?padID=string&text=string - POSTappendTextUsingPOST
/appendText?padID=string&text=string - GETcopyPadUsingGET
/copyPad?sourceID=string&destinationID=string&force=string - POSTcopyPadUsingPOST
/copyPad?sourceID=string&destinationID=string&force=string - GETcopyPadWithoutHistoryUsingGET
/copyPadWithoutHistory?sourceID=string&destinationID=string&force=string - POSTcopyPadWithoutHistoryUsingPOST
/copyPadWithoutHistory?sourceID=string&destinationID=string&force=string - GETgetAttributePoolUsingGET
/getAttributePool?padID=string - POSTgetAttributePoolUsingPOST
/getAttributePool?padID=string - GETgetPadIDUsingGET
/getPadID?roID=string - POSTgetPadIDUsingPOST
/getPadID?roID=string - GETgetRevisionChangesetUsingGET
/getRevisionChangeset?padID=string&rev=string - POSTgetRevisionChangesetUsingPOST
/getRevisionChangeset?padID=string&rev=string - GETgetSavedRevisionsCountUsingGET
/getSavedRevisionsCount?padID=string - POSTgetSavedRevisionsCountUsingPOST
/getSavedRevisionsCount?padID=string - GETgetStatsUsingGET
/getStats - POSTgetStatsUsingPOST
/getStats - GETlistSavedRevisionsUsingGET
/listSavedRevisions?padID=string - POSTlistSavedRevisionsUsingPOST
/listSavedRevisions?padID=string - GETmovePadUsingGET
/movePad?sourceID=string&destinationID=string&force=string - POSTmovePadUsingPOST
/movePad?sourceID=string&destinationID=string&force=string - GETrestoreRevisionUsingGET
/restoreRevision?padID=string&rev=string - POSTrestoreRevisionUsingPOST
/restoreRevision?padID=string&rev=string - GETsaveRevisionUsingGET
/saveRevision?padID=string&rev=string - POSTsaveRevisionUsingPOST
/saveRevision?padID=string&rev=string
API details
- Base URL
http://etherpad.localhttp://pads.mro.name/api/1.2.15- Authentication
- An API key in the apikey query parameter
- Operations
- 96 operations on 48 pathsGET 48POST 48
- Main resources
- pad 42group 14author 10session 6
- Response formats
application/json- Description format
- OpenAPI 3.0.2, API version
1.2.15 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Etherpad API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Etherpad API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the apikey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “appends a chat message” (GET /appendChatMessage?padID=string&text=string&authorID=string&time=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Etherpad API?
Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on… It is listed under Developer tools and has 96 endpoints.
Who publishes the Etherpad API?
It is listed from Etherpad's public API description (an OpenAPI document), not published by Etherpad on Swastik Codes. Anyone who controls etherpad.org can claim the profile by adding a DNS TXT record.
What is the base URL of the Etherpad API?
Its description lists 2 base URLs: http://etherpad.local, http://pads.mro.name/api/1.2.15. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Etherpad API?
With an API key in the apikey query parameter.
How many endpoints does the Etherpad API have?
96 operations on 48 paths (48 GET, 48 POST). The largest groups are pad, group, author, session.
Is forking the Etherpad API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.