Getting Started

The Woorise API (BETA) lets you securely access and manage pages, forms, entries, and more using RESTful endpoints and JSON responses. It’s built to be simple, predictable, and ready for integrations, automations, and custom apps. If you only need to send form submissions, payment data, or other events to an external API, you might find our Webhooks even easier.

Woorise API

Woorise API is RESTful, fully-featured, and easy to integrate with. You can use your favorite HTTP/REST library that is available for your programming language to make HTTP calls. You must send JSON payloads in your requests and expect to get JSON responses. Don’t forget to add these headers to each and every request.

Content-Type: application/json
Accept: application/json

Use the following base URL for all API endpoints. Replace {site} with your Woorise’s site name.

https://woorise.com/{site}/api/v1

Authentication

All requests to Woorise’s API require you to authenticate yourself to the service. In order to do this you must send the correct HTTP header with the correct API token. This can be done using application passwords. Check this guide on how to create application passwords and use them for authentication.

To authenticate your API requests, you need to include your username and application password in the request headers. Most applications will require you to set or choose your Woorise site URL.

Rate limits

Woorise API has a global rate limit of 60 requests per minute. If you exceed that rate limit you will receive a 429 error response with a “Too Many Attempts” message.

Each API request comes back with four headers related specifically to rate limiting:

Header	Meaning
X-RateLimit-Limit	The maximum number of API requests that the user can make per minute.
X-RateLimit-Remaining	The remaining number of API requests that the user can make per minute.
X-RateLimit-Reset	A date and time value indicating when the remaining limit resets.
X-RateLimit-Retry-After	Indicates the seconds remaining before you can make a new request.

HTTP status codes

Woorise returns standard HTTP response codes.

Code	Meaning	Description
200 OK	Success	The request was successful and the response body contains the requested data.
201 Created	Resource created	The request succeeded and a new resource (e.g., Page, Entry) was created.
202 Accepted	Processing	The request was accepted for processing but has not been completed yet.
204 No Content	Success, no data	The request was successful but no content is returned (e.g., after delete).
301 Moved Permanently	Redirect	The resource has been permanently moved to a new URL.
302 Found	Redirect	The resource has been temporarily moved to a different URL.
304 Not Modified	Caching	The resource has not changed since the last request (used with caching headers).
400 Bad Request	Invalid request	The request was invalid, often due to missing or invalid parameters.
401 Unauthorized	Authentication required	The request requires valid authentication (e.g., Application Passwords or API keys).
403 Forbidden	Access denied	The user is authenticated but does not have permission for this action.
404 Not Found	Resource missing	The requested resource (e.g., Page ID) could not be found.
405 Method Not Allowed	Invalid HTTP method	The resource does not support the HTTP method used (e.g., GET vs. POST).
409 Conflict	Conflict	The request conflicts with an existing resource or state.
410 Gone	Resource removed	The resource requested has been permanently removed.
429 Too Many Requests	Rate limit exceeded	The client has sent too many requests in a given timeframe.
500 Internal Server Error	Server error	An unexpected error occurred on the Woorise server.
502 Bad Gateway	Proxy error	The server received an invalid response from an upstream server.
503 Service Unavailable	Unavailable	The service is temporarily unavailable, often due to maintenance or overload.
504 Gateway Timeout	Timeout	The server did not receive a timely response from an upstream server.