REST API

Base URL

https://shipchart.app/api/v1/

All endpoints are prefixed with /api/v1/.

Authentication

All requests require a Bearer token in the Authorization header. Generate tokens in Settings → API Tokens.

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" \
     -H "Accept: application/json" \
     https://shipchart.app/api/v1/projects

See Authentication for full details on token abilities and error responses.

Response format

All responses are JSON. Successful responses return the requested data directly. List endpoints include pagination metadata:

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "last_page": 3,
    "per_page": 15,
    "total": 42
  },
  "links": {
    "first": "...?page=1",
    "last": "...?page=3",
    "prev": null,
    "next": "...?page=2"
  }
}

Rate limiting

The API allows 60 requests per minute per authenticated user. Rate limit headers are included in every response:

• X-RateLimit-Limit — 60
• X-RateLimit-Remaining — requests left in the window
• Retry-After — seconds until the limit resets (when exceeded)

Errors

Error responses use standard HTTP status codes: