This API endpoint allows you to return a list of all the manifests in Octopi.

Supported Formats

json

Errors

Code Description
400 Bad Request
403 Forbidden
404 Not Found
422 Unprocessable Entity
500 Internal Server Error

Examples

curl "https://app.octopi.co/api/v1/manifests.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"
{
  "actions": {
    "next_page": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/manifests.json?page=2&per=10"
    },
    "previous_page": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/manifests.json?page=1&per=10"
    }
  },
  "manifests": [
    {
      "client_identifier": "TEST123",
      "voyage_number": "JUL162025",
      "shipping_line_voyage_number": null,
      "sailing_date": null,
      "shipping_line": {
        "code": "OCTO",
        "name": "OCTO Shipping Company",
        "synonyms": [],
        "carrier_type": "ocean",
        "agent": {
            "name": "OCTO Agent"
        }
      },
      "voyage": {
        "number": "JUL162025"
      },
      "arrival_date": "2025-07-21",
      "departure_date": null,
      "remarks": "Test manifest remarks"
    }
  ]
}

Params

Param name Description
voyage_number
optional

To filter manifest based on voyage number. This must be a voyage number that exists in Octopi.

Validations:

  • Must be a String