Skip to main content

​
Blinksale API

Welcome to the Blinksale API documentation. Our API allows you to programmatically access and manage your Blinksale account, enabling you to automate your invoicing workflow and integrate Blinksale with your existing business systems.

​
Base URL

All API requests should be sent to the following base URL: 
https://app.blinksale.com/api/v1

​
Authentication

The Blinksale API uses token-based authentication. You can generate API tokens in your account settings under the API section. Include your API token in all requests using the Authorization header: 
Authorization: Bearer YOUR_API_TOKEN

​
Request Format

The API accepts JSON request bodies for POST, PUT, and PATCH requests. Be sure to include the Content-Type: application/json header with these requests. 
{
  "name": "Client Name",
  "email": "[email protected]"
}

​
Response Format

All responses from the API return JSON with a consistent structure: 
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    // Response data here
  }
}
In case of errors: 
{
  "success": false,
  "message": "Error message",
  "errors": {
    // Validation errors (if applicable)
  }
}

​
Rate Limiting

The API has rate limiting to ensure stability. You are currently limited to 120 requests per minute. If you exceed this limit, you’ll receive a 429 Too Many Requests response. Rate limit information is included in the response headers:
  • X-RateLimit-Limit: Maximum number of requests allowed per minute
  • X-RateLimit-Remaining: Number of requests remaining in the current window
  • X-RateLimit-Reset: Time (in seconds) when the rate limit will reset

​
API Resources

The Blinksale API allows you to manage the following resources:
  • Clients - Manage your client database
  • Contacts - Create, update, and delete client contacts
  • Estimates - Generate and manage estimates for clients
  • Invoices - Create, send, and manage invoices
  • Recurring Invoices - Setup and manage recurring invoice templates
  • Payments - Record and process payments
  • Taxes - Manage tax rates and settings
  • Units of Measurement - Define units for your products/services
  • Saved Line Items - Manage reusable items for estimates and invoices
See the sidebar for detailed documentation on each resource endpoint.