« Back to Flocknote API Documentation home
Flocknote uses the four standard HTTP request types in its RESTful API: GET, POST, PUT and DELETE. Read below for typical uses of each type of request.
GET requests (for retrieving objects)
GET https://www.flocknote.com/api/[object]/[id]/[submethod]
The object indicates the type of object with which you'd like to interact, the optional ID indicates that you'd like to interact with one particular object, and the optional operations allows you to retrieve certain information related to a particular object.
POST requests (for posting new objects)
POST https://www.flocknote.com/api/[object]
The object indicates the type of object you are posting. You will need to supply a body with a JSON-formatted array of the required information (see individual object API documentation for required fields). The API will return the ID of the newly-created object, or an error message if the object could not be created.
PUT requests (for updating existing objects)
PUT https://www.flocknote.com/api/[object]/[id]
The object indicates the type of object you are updating, and the ID indicates the particular object you are updating. Currently not supported for any objects, stay tuned for updates!
DELETE requests (for removing existing objects)
DELETE https://www.flocknote.com/api/[object]/[id]
The object indicates the type of object you are removing, and the ID indicates the particular object you are removing. Currently not supported for any objects, stay tuned for updates!