Project

Everything starts with a project. Kindly create a project by clicking on the project selection box at the top of the dashboard and click on the Create New Project button.

Locale

Locales are set project wide. This means that all endpoints within a project will return data in the locale set for that project.

API Key

An API key is associated with a project, and can be regenerated at any time from the API Key tab on the Settings page.

Teams

Multiple users can collaborate and work on a project. Any user can invite others to join a project by clicking on the Invite User button and entering their email address on the Manage Teams tab on the Settings page.

When a new team member joins a project, they are not required to upgrade their plans. It is the responsibility of the project owner to upgrade their plan to avail advanced features for that project and any other project they may have.

Advanced Configuration

Pagination Request Parameter Labels: This is where you set the label for the pagination request parameters.

For eg:

?=x&=y

The default values are page and limit respectively.

If a page number is set in the request parameter, it will return same page number within the pagination response data.

If a limit is set in the request parameter, it will return a total record of the limit set.

Note: The settings is for setting the labels, not the actual numbers.

Pagination Response Parameter Labels: This is where you set the labels for the pagination data within the response body.

The pagination data is returned in this format:

{
    "data": [
        ...
    ],
    "": {
        "": 1,
        "": 2,
        "": null,
        "": 5,
        "": 200,
        "": 1000
    }
}

The labels for this data can be changed from the "Advanced Configuration" tab on the Settings page. Eg: currPage can be changed to currentPage or page.