v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Addresses

Search for one or more addresses

Search for one or more addresses.

get/v1/Addresses

Query parameters

search.address_idinteger[]

Query by address identifier.

search.customer_idinteger[]

Query by account identifier.

search.citystring[]

Query by city.

search.state_or_provincestring[]

Query by 2-character state/province abbreviation.

search.postal_codestring[]

Query by postal code (i.e. zip)

search.line_1string[]

Query by primary address line.

search.line_2string[]

Query by secondary address line.

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.modified_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by modified date.

search.modified_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by modified date.

search.is_provider_validatedboolean

Query by provider validation (true or false).

search.is_USPS_validatedboolean

Query by USPS validation (true or false).

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

All 340 operations