Addresses

Entity›Address

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

Field	Type	Description
Street	String	Street name
HouseNumber	Double	House number
HouseNumberSuffix	String	House number suffix (e.g., "A", "bis")
Extra	String	Extra address line
Postalcode	String	Postal / ZIP code
City	String	City
Latitude	Double	GPS latitude
Longitude	Double	GPS longitude

Relationships

Relationship	Target Entity	Cardinality	Description
Relation	Relation	N:1	Parent relation
Person	Relation.Person	N:1	Linked person
Organization	Relation.Organization	N:1	Linked organisation
AddressType	Datastore.AdressType	N:1	Address type (visiting, postal, etc.)
Country	Datastore.Country	N:1	Country
State	Datastore.State	N:1	State / province
EventLocation	Datastore.EventLocation	N:1	Event location
Lead	Activity.Lead	N:1	Linked lead
Appointment	Activity.Appointment	N:1	Linked appointment
WorkOrder	Activity.WorkOrder	N:1	Linked work order

Expanding Relationships

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

Navigating Relationships

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}

Custom Query

Build your own OData query against Address. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.

GET/v1/odata/Address?$top=10