Get a paginated list of addresses. It can be filtered by specific fields.

Resource URL

Cluster	URL

Cluster	URL
Australia	https://api.bbamastro.com/address/address
US	https://api-us.bbamastro.com/address/address

Parameters

Type	Name	Description	Schema

Type

Name

Description

Schema

Query

name

optional

Filter by address name

string

HTTP Code	Description	Schema

HTTP Code	Description	Schema
200	OK	Page<<AddressPublicProjection>>
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Type: apiKey

Name: Authorization

In: HEADER

Name	Schema

Name	Schema
content optional	< AddressPublicProjection > array
first optional	boolean
last optional	boolean
number optional	integer (int32)
numberOfElements optional	integer (int32)
size optional	integer (int32)
sort optional	Sort
totalElements optional	integer (int64)
totalPages optional	integer (int32)

Name	Description	Schema

Name	Description	Schema
addressLine1 optional	Address line 1	string
addressLine2 optional	Address line 2	string
company optional	Address company name	string
customerCarrierAccountCode optional	Customer carrier account code	string
email optional	Address email	string
firstName optional	Address first name	string
id optional	Address identifier	integer (int64)
lastName optional	Address last name	string
latitude optional	Address latitude	number (double)
location optional	Location identifier	Location
longitude optional	Address longitude	number (double)
notes optional	Address notes	string
phone optional	Address phone number	string

Please refer to the Additional Reference section for more information on BBA Integration API objects.