Skip to main content
Welcome to the Kimp360 Client API Quickstart Guide! This guide will walk you through the essential steps to set up your development environment and start making API calls. Let’s get you integrated in under 5 minutes!

​
🛠️ Step 1: Setup Your Development Environment

Follow these initial steps to prepare your environment for interacting with the Kimp360 API.

​
Obtain Your API Key

You’ll need an API key to authenticate your requests. You can find or generate your API key from your account settings in the Kimp360 dashboard.
Your API key is sensitive. Treat it like a password and keep it secure. Do not expose it in client-side code.

​
🔑 Step 2: Authentication & Authorization

Secure communication with our API is paramount. Here’s how authentication and rate limiting work:
All API requests must be authenticated. Include your API key in the x-api-key header for every request: http x-api-key: YOUR_API_KEY Replace YOUR_API_KEY with the actual key you obtained in Step 1.
To ensure fair usage and stability for all users, the API implements rate limiting. Key points:
  • Limits: Typically, 60 requests per minute per API key (this may vary, check specific documentation if provided). - Headers: Look for X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers in API responses to track your usage. - Exceeding Limits: If you exceed the rate limit, you’ll receive a 429 Too Many Requests HTTP status code. The Retry-After header may indicate how long to wait before retrying.

​
🚀 Step 3: Making Your First API Request

Let’s put it all together and make a sample request.
Here’s an example of how to make a GET request to list tasks for a specific project: http GET /tasks?projectId=123&perPage=10 HTTP/1.1 Host: api.kimp360.com x-api-key: YOUR_API_KEY Accept: application/json Remember to replace: - YOUR_API_KEY with your valid API key. - projectId=123 and perPage=10 with relevant query parameters for your test.

​
📚 Available Resources

The Kimp360 API provides a rich set of endpoints for managing various resources. Explore them to understand the full capabilities:

Tasks

Manage work items with support for simple, question, and detailed formats. Includes file attachments and product specifications.

Labels

Create and manage colored labels for task categorization and organization.

Brands

Handle brand profiles, logos, and user associations for task management.

Tags

Create custom-styled tags for content organization.

Request Types

Access predefined categories like bugs, features, enhancements, and support requests.

​
📦 Response Format

All successful API responses (HTTP 2xx status codes) follow a consistent JSON structure: 
{
  "status": true,
  "data": {
    // Your requested data will be here
  },
  "message": "Operation successful" // Optional: Provides a human-readable message
}
  • status (boolean): Indicates the success of the operation.
  • data (object/array): Contains the requested resource(s).
  • message (string, optional): A descriptive message about the outcome.

​
⚠️ Error Handling

The API uses standard HTTP status codes to indicate errors. Error responses also follow a consistent JSON format: 
{
  "status": false,
  "message": "A concise error message describing what went wrong.",
  "error": "ErrorType", // e.g., "Validation Error", "Authentication Error"
  "details": {
    // Optional: Provides more specific details about the error
    "field_name": "Specific error for this field."
  },
  "statusCode": 400 // The HTTP status code
}
Refer to our detailed API Error Handling guide for a comprehensive list of error codes and troubleshooting tips.
Next Steps
Now that you’ve got the basics, dive deeper into specific API Reference sections or explore our advanced guides!