Get Started

Smore API is a set of RESTful APIs that allows you to interact with Smore programmatically. You can use Smore API to create, read, update, and delete your forms, collected data, Webhooks, and more.

We are working hard to add more features to the API. Currently, you can use the API to list your forms, create or delete Webhooks, and get the collected data of your forms.

At this stage, anyone with a Smore account can use our API, whether you are on a free plan or a paid plan.

The Base URL for all APIs is https://smore.im/api/v1.

You must use the HTTPS protocol to access the API.

Smore's API currently supports authentication using OAuth 2.0.

To use the API, you need to register an OAuth application with Smore and then obtain an access token using the OAuth 2.0 authorization code flow. Please refer to the OAuth 2.0 Authentication document for more information.

When making API requests, you need to include your API token in the request header.

Our API uses GET, POST, PUT, PATCH, and DELETE methods.

All requests and responses are formatted in JSON.

When a request fails, the API will return an HTTP status code and a JSON object containing detailed information about the error.

To ensure quality of service, we have limited the rate of requests per minute for each account.

• If you use a Personal API Key, you can make up to 3 requests per minute for each account.

• If you use OAuth 2.0, you can make up to 20 requests per minute for each account. If your application requires a higher rate limit, please contact us.

If your request rate exceeds the limit, you will receive a 429 Too Many Requests status code. You can check the Retry-After field in the response header, which will tell you when you can make a request again.