Skip to main content
Lymo provides a RESTful API that gives you programmatic access to manage resources, receive real-time event notifications via webhooks, and integrate Lymo’s capabilities directly into your application. All requests use standard HTTP methods, and all responses are returned as JSON.

Quick Start

Make your first API call in minutes.

Authentication

Learn how to obtain and use your API key.

API Reference

Browse all available endpoints with live examples.

Webhooks

Receive real-time event notifications in your app.

​
How the API works

The Lymo API follows REST conventions. Every resource has a stable URL, and you interact with it using standard HTTP verbs:
MethodAction
GETRetrieve one or more resources
POSTCreate a new resource
DELETERemove an existing resource
All requests must include an Authorization header with your Bearer token. Responses always include an HTTP status code and a JSON body.

​
Base URL

https://api.lymo.jp
All endpoints are relative to this base URL.

​
Next steps

1

Get your API key

Sign up and obtain your API key from the Lymo dashboard. See Authentication for details.
2

Make your first request

Follow the Quick Start guide to make your first successful API call.
3

Explore the API

Browse the API Reference to discover all available endpoints and their parameters.
4

Set up webhooks

Configure webhooks to receive real-time notifications when events occur.