Ports

Endpoints relating to Ports objects

List of ports

Request
query Parameters
page
integer >= 1
Default: 1

Page number of the page to retrieve

Example: page=1
per
integer [ 1 .. 100 ]
Default: 20

Count of items in each page. Should be between 1 and 100 (inclusive)

Example: per=20
f.port_type
string

Filter by the type of port. Ports can have more than one type

Enum: "airport" "railport" "roadport" "seaport"
f.unlocode
string

Filter by unlocode.

Example: f.unlocode=CATOR
Responses
200

collection of ports

Response Schema: application/json
_object
string
self
string
version
integer
object
_object
string
prev
string or null
next
string or null
total_count
integer
Array of objects or null (Place)
400

error

get/ports
Response samples
application/json
{
  • "_object": "/api/response",
  • "self": "https://api.flexport.com/ports?page=2&per=10",
  • "version": 2,
  • "data": {
    • "_object": "/api/collections/paginated",
    • "prev": "https://api.flexport.com/ports?page=1&per=10",
    • "next": "https://api.flexport.com/ports?page=1&per=10",
    • "total_count": 1960,
    • "data": [
      • {
        },
      • {
        }
      ]
    }
}
➔ Next to Document Types