Get a list of address book entries

Authorizations:
query Parameters
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

Response Schema: application/json
page_size
integer
Array of objects (AddressBookEntry)
total_count
integer
total_pages
integer

Request samples

curl -i -X GET \
  'https://{host}{basePath}/address-book/?page=0&page-size=0&ordering=string&q=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0,
  • "total_pages": 0
}
Copyright © Shipwell 2020. All right reserved.