API Reference

Complete reference documentation for the PortTask REST API.

Overview

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.

Base URL

https://api.intliq.com/v1

Authentication

All API requests require authentication using a Bearer token:

JWT Authentication

Include the JWT token in the Authorization header:

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Obtaining Tokens

Tokens are obtained through Supabase authentication. For programmatic access, use the API key authentication method in your organization settings.

API Keys

For server-to-server integrations, generate an API key from Settings → API Keys. API keys have configurable scopes and expiration.

Rate Limiting

API requests are rate limited to ensure fair usage:

Free

100 requests/minute

Professional

1,000 requests/minute

Enterprise

Custom limits

Rate Limit Headers

Check X-RateLimit-Remaining and X-RateLimit-Reset headers in responses.

API Endpoints

Available API endpoints organized by resource:

Port Calls

GET/port-callsList all port calls

POST/port-callsCreate port call

GET/port-calls/:idGet port call details

PUT/port-calls/:idUpdate port call

DELETE/port-calls/:idDelete port call

Service Orders

GET/service-ordersList service orders

POST/service-ordersCreate service order

PUT/service-orders/:id/statusUpdate status

POST/service-orders/:id/assignAssign vendor

Vendors

GET/vendorsList vendors

POST/vendorsCreate vendor

GET/vendors/:id/performanceGet performance metrics

More Resources

Vessels

Ports

Users

Playbooks

RFQs

Quotes

Comments

Notifications

Workspaces

Tasks

Documents

Analytics

Response Format

Success Response

{
  "success": true,
  "data": {
    "id": "pc_abc123",
    "vessel": "MV Atlantic Star",
    "port": "Rotterdam",
    "eta": "2024-01-15T08:00:00Z",
    "status": "SCHEDULED"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid port call data",
    "details": [
      { "field": "eta", "message": "ETA must be in the future" }
    ]
  }
}

Paginated Response

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 156,
    "totalPages": 8
  }
}

HTTP Status Codes

200

Success

Request completed successfully

201

Created

Resource created successfully

400

Bad Request

Invalid request data

401

Unauthorized

Invalid or missing authentication

403

Forbidden

Insufficient permissions

404

Not Found

Resource not found

422

Unprocessable

Validation errors

429

Too Many Requests

Rate limit exceeded

500

Server Error

Internal server error

SDKs & Libraries

JavaScript/TypeScriptAvailable

@porttask/sdk

PythonIn Development

porttask

GoIn Development

go-porttask

Webhooks

Receive real-time notifications when events occur in PortTask:

port_call.created

port_call.status_changed

service_order.created

service_order.completed

rfq.quote_received

sla.breach_warning

Get Started

Return to the getting started guide.

Getting Started

{ "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Invalid port call data", "details": [ { "field": "eta", "message": "ETA must be in the future" } ] } }