Skip to main content
Version: Next

Swagger API Documentation

This section provides detailed documentation for the API endpoints available in our application, generated using Swagger. You can explore the various endpoints, their parameters, request and response formats, and other relevant information.

Getting Started​

To access the Swagger UI, navigate to the following URL in your web browser: /v3/api-docs/

This will display the interactive Swagger interface where you can explore the API documentation.

API documentation

API Endpoints​

The API consists of multiple endpoints categorized by functionality. Each endpoint includes details such as HTTP methods, request parameters, response formats, and example requests/responses.

Example Endpoint​

  • Endpoint: PATCH /v3/users/me
  • Description: Update user information.
  • Parameters:
    • name: Name of the account.
    • email: Email of the account.
  • Responses:
    • 200 OK: Success.
    • 400 Bad Request: Invalid request parameters.

Authentication​

Almost all endpoints require authentication. Please refer to the specific endpoint documentation for details on how to authenticate your requests.

Further Assistance​

If you have any questions or need further assistance with the API documentation, please contact support team.

tip

You have to generate an access token from your account settings. To login method throughout API is not supported.