Limits

The LINE WORKS APIs have two types of limits:

• Rate limits
• Concurrent access limits

Rate limits {#ratelimit}

An API rate limit is the number of API requests that you can make within a specific time period. If the API rate limit is exceeded, the request fails with HTTP error 429.

{    "code": "TOO_MANY_REQUESTS",    "description": "API rate limit exceeded"}

Rate limits by pricing plan {#ratelimit-apply-target}

API rate limits vary depending on the pricing plan.
The available scopes vary for each pricing plan, which you can see in List of scopes.

The following rate limits apply regardless of the plan.

Check rate limit information {#how-to-check-ratelimit}

When you make a request to the rate-limited API, the following four parameters are included in the response header to let you know the current API calls, the rate limit value, the remaining API calls, and the time left until reset.

Note

• When you make an API call to get a file download URL, HTTP 302 is returned, meaning no rate limit parameters are included in the response header. For more information, see Upload or Download Files.

How to handle API rate limits {#how-to-handle-ratelimit}

If your API call is rate-limited, you need to reduce the number of API requests while handling HTTP error 429 and retrying the failed request. Using caching can avoid unnecessary API requests.

If the client app does not properly handle API requests based on the API rate limit, an unintended error may occur, causing the app not to work as expected. Therefore, you need to first limit the number of API requests made by the client app. You can cache the data that does not frequently change, such as user information. You can also consider that there are cases where part of the data to get is already included in the previous API response. Above all, make sure to give enough time between request retries so that the rate limit is not exceeded due to unnecessary requests.

Concurrent access limits {#concurrent-access}

The maximum number of concurrent API requests is 5; if it is exceeded, the API request may fail.

{    "code": "TOO_MANY_REQUESTS",    "description": "Concurrent access fail"}

Caution

• Some API operations may have different limits.