Welcome
In this API reference we will describe the core functionalities of our API and the REST layer along with it's endpoints that are available.
BASE URL
Authentication
API authentication is handled by access tokens that conform to the OAuth 2.0 protocol. All tokens are a signed JWT that includes configuration and authorization information.
Permissions
access_token is required for querying and mutating Resources from API. user access token is able to access and change its own Resources. admin access token is able to access and change its own Resources as well as the Resources of users over which it has controlErrors
Requests made to our REST API will respond with the appropriate response code. Successful request will respond with a response code in the 2xx range. Failed requests due to a mistake made by the client will respond with a response code in the 4xx range. Failed requests due to an error with the minimaa server will respond with a response code in the 5xx range.
An error object will consist of three fields, a code field, a type field and a message field.
Error example
Pagination
Minimaa utilizes cursor-based pagination via the starting_after and limit parameters.
All top-level API resources have support for bulk fetches. For instance, you can list users, list projects, and list orders. These list API methods share a common structure, taking at least these two parameters: limit and starting_after.
A limit on the number of objects to be returned is between 1 and 100. Default limit value is 10. A starting_after is a cursor for use in pagination. starting_after is a string that defines your place in the list. For instance, if you make a list request and receive hasNextPage of value true in your pageInfo response, your subsequent call can include starting_after=endCursor in order to fetch the next page of the list.
In order to fetch the first page you have to pass an empty string in starting_after parameter.
Example
Versioning
The latest Minimaa API version is v1
Note that our API and our SDK are not sharing the same versioning system. For example, the Minimaa API is versioned with a different pace and numbering compared to Minimaa SDK.
Setting the version of the API is required. To set the API version, set version tag in the url. https//api.minimaa.co/v1/
