API Reference

This documentation provides a comprehensive guide to the Kurrent API, including authentication methods, available endpoints, and example requests. Our API follows RESTful principles and uses standard HTTP methods.

Authentication

All API requests require authentication using an API key. The API key should be included in the request headers as x-api-key.

curl -X GET https://api.kurrent.com/api/external/budget-views?project_id=123 \
  -H "x-api-key: your-api-key" \
  -H "x-organization-id: your-organization-id" \
  -H "x-company-id: your-company-id"

Required Headers

Most API endpoints require the following headers:

Response Format

All API responses are returned in JSON format. Successful responses include a data field containing the requested information. Error responses include an error field with a description of what went wrong.

Success Response Example

{
  "data": [
    {
      "id": 123,
      "name": "Example Resource",
      // Additional resource properties
    }
  ]
}

Error Response Example

{
  "error": "Invalid or missing API key"
}

Available Endpoints

Test & Accept offers a variety of endpoints for accessing and managing your data:

Core Resources

• Tests - Create and manage tests for acceptance criteria
• Acceptance Criteria - Define and track acceptance criteria
• Statements of Work - Manage SOWs and their items
• Items - Manage requirements and task items with type-specific behaviors
• Dependencies - Track internal and external dependencies

Legacy Kurrent Endpoints

• Prime Contracts - Access and manage prime contracts
• Prime Contract Details - Get detailed information about specific prime contracts
• Budget Views - Access project budget views
• Budget View Snapshots - Access budget view snapshots for a project
• Budget View Snapshot - Get detailed information about a specific budget view snapshot
• Project Commitments - Access project commitments from Procore
• Create Purchase Order - Create a new purchase order in Procore

Rate Limits

The API has rate limits to ensure fair usage. Current rate limits are:

• 100 requests per minute per API key
• 5,000 requests per day per API key

If you exceed these limits, you will receive a 429 Too Many Requests response.

Pagination

For endpoints that return multiple items, results are paginated. You can control pagination using the following query parameters:

• page: The page number (default: 1)
• limit: The number of items per page (default: 20, max: 100)

Errors

The API uses standard HTTP status codes to indicate the success or failure of a request. Common status codes include:

• 200 OK: The request was successful
• 400 Bad Request: The request was invalid or missing required parameters
• 401 Unauthorized: Authentication failed or missing API key
• 404 Not Found: The requested resource was not found
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: An error occurred on the server

For more detailed information about specific errors, see the Errors documentation.