Skip to content
Console(opens in a new tab)

AddressInput

The fields of AddressInput, and the part each one belongs to.

Match. This input describes the records that you want to find. You pass it to SearchInput.address, SearchInput.addresses, SearchFieldGroupInput.address and PersonInput.address.

Input object.

Field Type Part Description
id ID Match The unique identifier of this object.
street1 String Match The first line of the street address, such as 123 Main St.
street2 String Match The second line of the street address, such as a unit or a floor.
city String Match The city of the address.
state String Match The state of the address, as a two-letter abbreviation.
postalCode String Match The ZIP code of the address.
query {
search(searchInput: {
entityType: ADDRESS
address: { street1: "5918 Stoneridge Mall Rd", city: "Pleasanton", state: "CA" }
conditions: { limit: 1 }
}) {
... on Address {
id
fullAddress
}
}
}

Response, as returned:

{
"data": {
"search": [
{
"id": "000002ce-0003-3f03-0000-0b8000000000",
"fullAddress": "5918 STONERIDGE MALL RD PLEASANTON CA 94588"
}
]
}
}