Notehub API Introduction

This API reference contains an overview of all requests relevant to interacting with Notehub.io. Each section details request parameters, response members, example curl requests, and JSON responses.

Authentication

All requests to the Notehub API require an authentication token in the form of an X-SESSION-TOKEN header. This token can be obtained via a request to the /auth/login endpoint using a Notehub username and password in the body of the request.

warning

This authentication method will be deprecated in favor of an OAuth-based solution in the near future. We will provide updated instructions when the OAuth option is available for public use.

COPY
curl -X POST
     -L 'https://api.notefile.net/auth/login'
     -d '{"username":"[you@youremail.com]", "password": "[your_password]"}'

note

Accounts using GitHub Authentication

If an account was created by using "Sign in with GitHub", by default there is no password available for API authentication purposes. Therefore, users will need to set a password in the Account settings panel in Notehub.io. This password will only be used when generating an authentication token.

API Limits and Pricing

API access is limited based on the type of Notehub subscription. For more information on pricing and the tiers of service, please our Notehub.io service information page.