Search for one or more addresses

Search for one or more addresses.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Metadata
search.address_id
array of int32s

Query by address identifier.

search.address_id
search.customer_id
array of int32s

Query by account identifier.

search.customer_id
search.city
array of strings

Query by city.

search.city
search.state_or_province
array of strings

Query by 2-character state/province abbreviation.

search.state_or_province
search.postal_code
array of strings

Query by postal code (i.e. zip)

search.postal_code
search.line_1
array of strings

Query by primary address line.

search.line_1
search.line_2
array of strings

Query by secondary address line.

search.line_2
date-time

Query by created date.

date-time

Query by created date.

date-time

Query by modified date.

date-time

Query by modified date.

boolean

Query by provider validation (true or false).

boolean

Query by USPS validation (true or false).

int32

Defines how many items to return at a time.

int32

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

string

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html