Complete reference documentation for the PortTask REST API.
The PortTask API is a RESTful API that allows you to programmatically interact with all aspects of the platform. Use it to integrate PortTask with your existing systems, automate workflows, or build custom applications.
https://api.intliq.com/v1All API requests require authentication using a Bearer token:
Include the JWT token in the Authorization header:
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...Tokens are obtained through Supabase authentication. For programmatic access, use the API key authentication method in your organization settings.
For server-to-server integrations, generate an API key from Settings → API Keys. API keys have configurable scopes and expiration.
API requests are rate limited to ensure fair usage:
100 requests/minute
1,000 requests/minute
Custom limits
Check X-RateLimit-Remaining and X-RateLimit-Reset headers in responses.
Available API endpoints organized by resource:
{
"success": true,
"data": {
"id": "pc_abc123",
"vessel": "MV Atlantic Star",
"port": "Rotterdam",
"eta": "2024-01-15T08:00:00Z",
"status": "SCHEDULED"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid port call data",
"details": [
{ "field": "eta", "message": "ETA must be in the future" }
]
}
}{
"success": true,
"data": [...],
"pagination": {
"page": 1,
"limit": 20,
"total": 156,
"totalPages": 8
}
}Request completed successfully
Resource created successfully
Invalid request data
Invalid or missing authentication
Insufficient permissions
Resource not found
Validation errors
Rate limit exceeded
Internal server error
@porttask/sdkporttaskgo-porttaskReceive real-time notifications when events occur in PortTask:
port_call.createdport_call.status_changedservice_order.createdservice_order.completedrfq.quote_receivedsla.breach_warningReturn to the getting started guide.