API Overview
Welcome to the Tidyflow API documentation. Our RESTful API allows seamless integration with our platform, providing access to a suite of features for efficient practice management, including client and project management, task tracking, and more.
The base URL for all API endpoints is: <https://app.tidyflow.com/api/v1/>
All API requests require authentication. We utilize token-based authentication (Bearer token) to protect your data. Include your token in the Authorization header of each request.
For details on obtaining and managing your authentication token, refer to our Authentication Guide.
Our API offers comprehensive functionality:
- Clients: Manage client information with create and read operations.
- Tasks: Create new tasks and retrieve task information.
- Users: Retrieve user information.
Responses are in JSON format. Successful interactions return an HTTP 200 OK status code with the JSON response body. Errors include an HTTP status code and a message for troubleshooting.
We version our API to maintain compatibility. Include the version in your endpoint paths. The latest version is v1.
Rate limits are in place to ensure service stability. Limits are set at 500 requests per hour per user. Exceeding this limit results in a 429 Too Many Requests status code.
Base URL
The base URL for all API endpoints is: <https://app.tidyflow.com/api/v1/>
Authentication
All API requests require authentication. We utilize token-based authentication (Bearer token) to protect your data. Include your token in the Authorization header of each request.
For details on obtaining and managing your authentication token, refer to our Authentication Guide.
Features
Our API offers comprehensive functionality:
- Clients: Manage client information with create and read operations.
- Tasks: Create new tasks and retrieve task information.
- Users: Retrieve user information.
Response Format
Responses are in JSON format. Successful interactions return an HTTP 200 OK status code with the JSON response body. Errors include an HTTP status code and a message for troubleshooting.
Versioning
We version our API to maintain compatibility. Include the version in your endpoint paths. The latest version is v1.
Rate Limiting
Rate limits are in place to ensure service stability. Limits are set at 500 requests per hour per user. Exceeding this limit results in a 429 Too Many Requests status code.
Updated on: 06/03/2024
Thank you!