API Overview
The Centro Access API provides programmatic access to work order management functionality for external systems and integrations. The API is built using REST principles and returns JSON responses.
Base URL
All API endpoints are available at:
https://app.centroaccess.com/api/v1/external/
API Endpoints
Centro Access provides three core API endpoints for work order management:
📋 List Work Orders
GET /workorders/
Retrieve a paginated list of work orders with powerful filtering and search capabilities.
Key Features:
- Filter by status, priority, service category, team, and date range
- Pagination support (up to 100 results per page)
- Sort by creation date (newest first)
➕ Create Work Order
POST /workorders/
Create new work orders programmatically for seamless integration with external systems.
Key Features:
- Required fields: title and client contact
- Optional location coordinates and team assignment
- Automatic status tracking and timestamps
🔍 Get Work Order Details
GET /workorders/{id}/
Retrieve comprehensive details about a specific work order including related data.
Key Features:
- Complete work order information
- Related call logs and inspections
- Team and service zone details
Authentication
All API endpoints require API Key authentication. Include your API key in the Authorization header:
Authorization: Api-Key your-api-key-here
Data Format
All requests and responses use JSON format. Include the Content-Type header for POST requests:
Content-Type: application/json
Response Format
All API responses follow consistent JSON structure:
Success Response:
{
"success": true,
"data": { ... },
"message": "Operation completed successfully"
}
Error Response:
{
"error": "Error description",
"details": { ... }
}
Rate Limiting
API requests are subject to rate limiting:
- Hourly Limit: 1,000 requests per API key
- Burst Limit: 100 requests per minute
- Rate limit headers included in responses
Getting Started
- Obtain an API Key - Learn how to create and manage API keys
- Authentication Guide - Understand how to authenticate your requests
- List Work Orders - Start by listing existing work orders
- Create Work Orders - Learn to create new work orders
- Get Work Order Details - Retrieve detailed work order information
Quick Example
Here's a quick example of creating a work order:
curl -X POST "https://app.centroaccess.com/api/v1/external/workorders/" \
-H "Authorization: Api-Key your-api-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Install fiber connection",
"client_name": "John Doe",
"client_contact": "+1234567890",
"priority": "high",
"service_category": "installation"
}'
Next Steps
Ready to integrate? Check out our detailed guides:
- Authentication → Set up API key authentication
- List Work Orders → Query and filter work orders
- Create Work Order → Programmatically create work orders
- Get Work Order Details → Retrieve comprehensive work order data
- Code Examples → Ready-to-use code snippets
Support
Need help with the API? Contact our support team:
- Email: support@centroaccess.com
- Documentation: https://docs.centroaccess.com