Skip to main content

Addresses

EntityAddress

Addresses represent physical locations linked to relations, organisations, or activities. They store street, city, postal code, country, and GPS coordinates.

Use the Address endpoint to query and manage addresses. You can also access them via the Addresses navigation property on Relations.

Endpoints

List Addresses

GET/v1/odata/Address

Single Address

GET/v1/odata/Address({id})

Create Address

POST/v1/odata/Address

Update Address

PUT/v1/odata/Address({id})

Delete Address

DELETE/v1/odata/Address({id})

Fields

Address Fields

FieldTypeDescription
StreetStringStreet name
HouseNumberDoubleHouse number
HouseNumberSuffixStringHouse number suffix (e.g., "A", "bis")
ExtraStringExtra address line
PostalcodeStringPostal / ZIP code
CityStringCity
LatitudeDoubleGPS latitude
LongitudeDoubleGPS longitude

Relationships

RelationshipTarget EntityCardinalityDescription
RelationRelationN:1Parent relation
PersonRelation.PersonN:1Linked person
OrganizationRelation.OrganizationN:1Linked organisation
AddressTypeDatastore.AdressTypeN:1Address type (visiting, postal, etc.)
CountryDatastore.CountryN:1Country
StateDatastore.StateN:1State / province
EventLocationDatastore.EventLocationN:1Event location
AppointmentActivity.AppointmentN:1Linked appointment
WorkOrderActivity.WorkOrderN:1Linked work order

Expanding Relationships

GET/v1/odata/Address({id})?$expand=Relation
GET/v1/odata/Address({id})/Relation

Filtering Examples

GET/v1/odata/Address?$filter=City eq '{City}'&$top={top}
GET/v1/odata/Address?$filter=contains(Street, '{Street}')&$top={top}
GET/v1/odata/Address?$filter=Postalcode eq '{Postalcode}'&$top={top}
GET/v1/odata/Address?$filter=Latitude ne null&$top={top}