Get a list of address book entries

page	integer indicates what page of a list of query results you want to view
page-size	integer indicates the how many items to return per page in a list request
ordering	string determines which column to sort by. Prepend with '-' to sort desc
q	string search query

Responses

200

Successfully returned a list of address book entries

Response Schema: application/json

page_size	integer
	Array of objects (AddressBookEntry)
total_count	integer
total_pages	integer

default

Default error response

get/address-book/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"page_size": 0,
"results": [{"accessorials": [{"code": "string",
"currency_unit": "string",
"description": "string",
"id": 0,
"is_charge_code": true,
"long_description": "string",
"price": 0.1,
"type": "string"
}
],
"account_reps": ["string"
],
"address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"company_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"custom_data": { },
"default_appointment_type": {"code": "string",
"id": 0,
"name": "string"
},
"dock_external_id": "string",
"dock_hours_end": "14:15:22Z",
"dock_hours_start": "14:15:22Z",
"external_reference": "string",
"facility_id": "string",
"friday_close_time": "14:15:22Z",
"friday_open_time": "14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_default_origin": true,
"load_capacity_schedule": {"friday": 0,
"interval": "DAILY",
"interval_capacity": 0,
"monday": 0,
"open_on_us_holidays": true,
"open_on_weekends": true,
"saturday": 0,
"sunday": 0,
"thursday": 0,
"tuesday": 0,
"wednesday": 0
},
"location_name": "string",
"location_type": {"id": 0,
"name": "string"
},
"monday_close_time": "14:15:22Z",
"monday_open_time": "14:15:22Z",
"notes": "string",
"open_friday": true,
"open_monday": true,
"open_saturday": true,
"open_sunday": true,
"open_thursday": true,
"open_tuesday": true,
"open_wednesday": true,
"point_of_contacts": [{"email": "string",
"first_name": "string",
"job_title": "string",
"last_name": "string",
"phone_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"load_board_enabled": true,
"load_board_invite_last_sent_at": "2019-08-24T14:15:22Z",
"preferences": {"cancellation": true,
"delayed": true,
"delivered": true,
"eta_changed": true,
"picked_up": true,
"receive_bol_on_shipment_booked": true,
"shipment_booked": true,
"trailer_assigned": true
},
"user": "76f62a58-5404-486d-9afc-07bded328704"
}
],
"saturday_close_time": "14:15:22Z",
"saturday_open_time": "14:15:22Z",
"sunday_close_time": "14:15:22Z",
"sunday_open_time": "14:15:22Z",
"thursday_close_time": "14:15:22Z",
"thursday_open_time": "14:15:22Z",
"tuesday_close_time": "14:15:22Z",
"tuesday_open_time": "14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"wednesday_close_time": "14:15:22Z",
"wednesday_open_time": "14:15:22Z"
}
],
"total_count": 0,
"total_pages": 0
}