Overview

Welcome to the Fider API documentation.

The Fider API allows you to manage Posts and other data within your Fider instance in a simple, programmatic way using conventional HTTP requests. The endpoints are intuitive and powerful, allowing you to easily make calls to retrieve information or to execute actions.

Version

The API v1 was introduced on Fider v0.16.0. Make sure you're running the latest version of Fider to leverage the API. All Cloud users on fider.io are already on the latest so you can start using it right now.

Request

Allowed HTTP Verbs are GET, POST, PUT and DELETE. Request bodies must be JSON and sent with the Content-Type: application/json header, otherwise the request is rejected.

We recommend also sending Accept: application/json on every request. Without it, some error responses (such as 401, 403, 404 and 500) are returned as HTML pages instead of JSON.

Requests are sent to your Fider URL using the HTTP/HTTPS protocol.

Hosting	URL	Protocol
Cloud	`https://<subdomain>.fider.io` or, if configured, your custom domain name (e.g: `https://feedback.yourcompany.com`)	HTTPS only
Self-Hosted	The URL you have configured	HTTP or HTTPS

Response

Successful responses are encoded as application/json and use one of the following status codes.

Status Code	Description
200 OK	Fider has accepted and processed your request, no error was encountered.
400 Bad Request	Something is incorrect with your request, it might be missing a parameter or have an invalid value. See Error Messages below. An invalid API Key also returns this status.
401 Unauthorized	The endpoint requires authentication and no valid credentials were sent, or the authenticated user is blocked.
402 Payment Required	The site is locked (Fider Cloud only) and is in read-only mode. Only operations that change data are blocked.
403 Forbidden	The authenticated user is not allowed to perform the operation, for example because it requires a different role.
404 Not Found	The resource you're looking for doesn't exist.
500 Internal Error	This generally indicates a server-side problem on Fider and it cannot fulfill your request currently.

Error Messages

Every 400 Bad Request response contains a JSON payload with details of what went wrong. Each error (object) contains a message (string) describing what is incorrect and may also contain a field (string) property. If the error object doesn't contain the field, that's a general error message.

{
  "errors": [
    {
      "field": "color",
      "message": "Color is invalid."
    },
    {
      "field": "name",
      "message": "This tag name is already in use."
    }
  ]
}

When Accept: application/json is sent, the other error status codes return an empty JSON object ({}) as the body.