GET /api/v1/voyage_event_types

Retrieve all available voyage event types for the organization with pagination actions at the beginning of response.

Supported Formats

json

Errors

Code	Description
404	Not found.
500	Internal Server Error.

Examples

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

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

# Get specific page
curl 'https://app.octopi.co/api/v1/voyage_event_types?page=2' \
  -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/voyage_event_types?page=0",
      "method": "GET"
    },
    "next": {
      "url": "https://app.octopi.co/api/v1/voyage_event_types?page=2",
      "method": "GET"
    },
    "last": {
      "url": "https://app.octopi.co/api/v1/voyage_event_types?page=5",
      "method": "GET"
    },
    "index": {
      "url": "https://app.octopi.co/api/v1/voyage_event_types",
      "method": "GET"
    }
  },
  "voyage_event_types": [
    {
      "id": 1106,
      "name": "Pilot Boarded",
      "description": "Pilot boarding event",
      "is_date_range": true,
      "uses_service_boat": true,
      "uses_pilot": true,
      "uses_berths": false,
      "custom_value_identifier": null,
      "custom_value_type": null
    },
    {
      "id": 1107,
      "name": "Berthing",
      "description": "Vessel berthing event",
      "is_date_range": true,
      "uses_service_boat": false,
      "uses_pilot": true,
      "uses_berths": true,
      "custom_value_identifier": null,
      "custom_value_type": null
    },
    {
      "id": 1108,
      "name": "Customs Clearance",
      "description": "Customs clearance process",
      "is_date_range": false,
      "uses_service_boat": false,
      "uses_pilot": false,
      "uses_berths": false,
      "custom_value_identifier": null,
      "custom_value_type": null
    },
    {
      "id": 1110,
      "name": "Fuel Bunkering",
      "description": "Fuel bunkering operations",
      "is_date_range": true,
      "uses_service_boat": true,
      "uses_pilot": false,
      "uses_berths": false,
      "custom_value_identifier": "Fuel Type",
      "custom_value_type": "string"
    },
    {
      "id": 1111,
      "name": "Cargo Loading",
      "description": "Container loading operations",
      "is_date_range": true,
      "uses_service_boat": false,
      "uses_pilot": false,
      "uses_berths": false,
      "custom_value_identifier": "Container Count",
      "custom_value_type": "number"
    }
  ]
}

Params

Param name	Description
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