List Port Orders
Method
Path
port_orders
Request Parameters
| Name | Type | Description |
|---|---|---|
| created_before | RFC 3339 Timestamp | The end of the range. Must be in RFC 3339 format, except that the timezone may be omitted (e.g. '`2016-05-31T23:59:59`'). Defaults to now. |
| created_after | RFC 3339 Timestamp | The beginning of the range. Must be in RFC 3339 format, except that the timezone may be omitted (e.g. '`2016-05-31T23:59:59`'). Defaults to now. |
This operation also accepts paging parameters.
Response
A JSON object with success, message, data, and paging attributes. Results are paginated, and the
paging attribute holds information about the length of
the data. The data attribute is an array of
Port Order Objects.
Sample Call
curl -G https://api.phaxio.com/v2.1/port_orders \
-u 'API_KEY:API_SECRET'Sample Response
{
"success": true,
"message": "Retrieved port orders successfully",
"data": [
{
"id": 1234,
"contact_number": "+15551231234",
"contact_email": "alice@acme.com",
"account_identifier": "1234567",
"name_on_account": "Alice Acme",
"name_of_business": "Acme",
"provider_name": "Example Provider",
"port_type": "business",
"port_out_pin": "1234",
"billing_number": "+15551231234",
"billing_address1": "123 Test St.",
"billing_address2": null,
"billing_city": "Test City",
"billing_state": "IL",
"billing_zip": 12345,
"esig": "Alice Acme",
"status": "open",
"quantity": 1,
"created_at": "2021-07-07T18:56:04.590+00:00",
"updated_at": "2021-07-07T18:56:04.590+00:00",
"completed_at": null,
"requested_for": null,
"bill_received_at": null,
"port_numbers" [
{
"id": 1234,
"port_number": "+15551112222",
"status": "open"
},
{
"id": 5678,
"port_number": "+15553334444",
"status": "open"
}
]
}
],
"paging": {
"total": 1,
"per_page": 3,
"page": 1
}
}