GET /api/v1/voyages/:voyage_number/voyage_events

Returns all voyage events for a specific voyage with pagination actions at the beginning of response.

Supported Formats

json

Errors

Code	Description
404	Not found.
422	Unprocessable Entity.
500	Internal Server Error.

Examples

# Get all voyage events (default: page 1, 25 per page)
# Response includes 'actions' object with pagination URLs for easy navigation
curl 'https://app.octopi.co/api/v1/voyages/V001/voyage_events' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

# Get 100 events per page (maximum allowed)
curl 'https://app.octopi.co/api/v1/voyages/V001/voyage_events?per_page=100' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

# Get specific page with custom per_page
curl 'https://app.octopi.co/api/v1/voyages/V001/voyage_events?page=2&per_page=50' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

{
  "actions": {
    "previous": {
      "url": "https://app.octopi.co/api/v1/voyages/V001/voyage_events?page=0",
      "method": "GET"
    },
    "next": {
      "url": "https://app.octopi.co/api/v1/voyages/V001/voyage_events?page=2",
      "method": "GET"
    },
    "last": {
      "url": "https://app.octopi.co/api/v1/voyages/V001/voyage_events?page=3",
      "method": "GET"
    },
    "index": {
      "url": "https://app.octopi.co/api/v1/voyages/V001/voyage_events",
      "method": "GET"
    }
  },
  "voyage": {
    "id": 123,
    "voyage_number": "V001",
    "vessel_name": "MSC LORETO"
  },
  "voyage_events": [
    {
      "id": 1,
      "event_name": "Pilot Boarded",
      "event_type_id": 5,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "started_at": "2024-01-15T10:30:00Z",
      "completed_at": "2024-01-15T11:00:00Z",
      "custom_value": null,
      "service_boat": {
        "id": 2,
        "name": "Pilot Boat Alpha"
      },
      "pilot": {
        "id": 3,
        "name": "John Smith"
      },
      "user": {
        "id": 4,
        "name": "Jane Doe"
      },
      "notes": "Pilot boarding completed successfully"
    },
    {
      "id": 2,
      "event_name": "Vessel Berthing",
      "event_type_id": 3,
      "created_at": "2024-01-15T11:15:00Z",
      "updated_at": "2024-01-15T11:15:00Z",
      "started_at": "2024-01-15T11:15:00Z",
      "completed_at": "2024-01-15T11:45:00Z",
      "custom_value": null,
      "service_boat": null,
      "pilot": {
        "id": 3,
        "name": "John Smith"
      },
      "user": {
        "id": 4,
        "name": "Jane Doe"
      },
      "notes": "Vessel successfully berthed at terminal"
    }
  ]
}

Params

Param name	Description
voyage_number required	The voyage number to retrieve events for Validations: Must be a String
page optional	Page number for pagination Validations: Must be a Integer
per_page optional	Number of items per page (max 100) Validations: Must be a Integer