Retrieve Addresses
Retrieve Addresses from any connected Accounting software
Path parameters
id of the address you want to retrieve.
Query parameters
Set to true to include data from the original Accounting software.
Headers
The connection token
Response
Example response
{
"type": "Billing",
"street_1": "123 Main St",
"street_2": "Apt 4B",
"city": "New York",
"state": "NY",
"country_subdivision": "New York",
"country": "USA",
"zip": "10001",
"contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"field_mappings": {
"custom_field_1": "value1",
"custom_field_2": "value2"
},
"id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"remote_id": "address_1234",
"remote_data": {
"raw_data": {
"additional_field": "some value"
}
},
"created_at": "2024-06-15T12:00:00Z",
"modified_at": "2024-06-15T12:00:00Z"
}Changes
Changed in 4 of the 18 revisions of this API.19
- ○
added the optional property
cityto the response with the200statusresponse-optional-property-added
- ○
added the optional property
company_info_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
contact_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
countryto the response with the200statusresponse-optional-property-added
- ○
added the optional property
country_subdivisionto the response with the200statusresponse-optional-property-added
- ○
added the optional property
created_atto the response with the200statusresponse-optional-property-added
- ○
added the optional property
field_mappingsto the response with the200statusresponse-optional-property-added
- ○
added the optional property
idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
modified_atto the response with the200statusresponse-optional-property-added
- ○
added the optional property
remote_datato the response with the200statusresponse-optional-property-added
- ○
added the optional property
remote_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
stateto the response with the200statusresponse-optional-property-added
- ○
added the optional property
street_1to the response with the200statusresponse-optional-property-added
- ○
added the optional property
street_2to the response with the200statusresponse-optional-property-added
- ○
added the optional property
typeto the response with the200statusresponse-optional-property-added
- ○
added the optional property
zipto the response with the200statusresponse-optional-property-added
- ○
- ○
the endpoint scheme security
bearerwas removed from the APIapi-security-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
the endpoint scheme security
bearerwas added to the APIapi-security-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
the endpoint scheme security
bearerwas removed from the APIapi-security-removed
- ○