GET api/Addresses
Returns a list of all contact addresses in your database. This list is searchable using the OData protocol.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of Address| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressId | integer |
None. |
|
| AddressType | AddressType |
None. |
|
| UnitId | integer |
None. |
|
| ContactId | integer |
None. |
|
| IsPrimary | boolean |
None. |
|
| StreetAddress1 | string |
None. |
|
| StreetAddress2 | string |
None. |
|
| City | string |
None. |
|
| State | State |
None. |
|
| PostalCode | string |
None. |
|
| Links | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"AddressId": 1,
"AddressType": {
"AddressTypeId": 1,
"OrganizationId": 2,
"Description": "sample string 3",
"IsActive": true,
"IsSystemDefined": true,
"CreateDate": "2026-04-04T00:30:13.8434118-07:00",
"CreateUserId": 6,
"ModifyDate": "2026-04-04T00:30:13.8434118-07:00",
"ModifyUserId": 7,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"UnitId": 2,
"ContactId": 3,
"IsPrimary": true,
"StreetAddress1": "sample string 5",
"StreetAddress2": "sample string 6",
"City": "sample string 7",
"State": {
"StateId": 1,
"OrganizationId": 2,
"Name": "sample string 3",
"Abbreviation": "sample string 4",
"IsActive": true,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"PostalCode": "sample string 8",
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
{
"AddressId": 1,
"AddressType": {
"AddressTypeId": 1,
"OrganizationId": 2,
"Description": "sample string 3",
"IsActive": true,
"IsSystemDefined": true,
"CreateDate": "2026-04-04T00:30:13.8434118-07:00",
"CreateUserId": 6,
"ModifyDate": "2026-04-04T00:30:13.8434118-07:00",
"ModifyUserId": 7,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"UnitId": 2,
"ContactId": 3,
"IsPrimary": true,
"StreetAddress1": "sample string 5",
"StreetAddress2": "sample string 6",
"City": "sample string 7",
"State": {
"StateId": 1,
"OrganizationId": 2,
"Name": "sample string 3",
"Abbreviation": "sample string 4",
"IsActive": true,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"PostalCode": "sample string 8",
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
<Address>
<AddressId>1</AddressId>
<AddressType>
<AddressTypeId>1</AddressTypeId>
<CreateDate>2026-04-04T00:30:13.8434118-07:00</CreateDate>
<CreateUserId>6</CreateUserId>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<IsSystemDefined>true</IsSystemDefined>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<ModifyDate>2026-04-04T00:30:13.8434118-07:00</ModifyDate>
<ModifyUserId>7</ModifyUserId>
<OrganizationId>2</OrganizationId>
</AddressType>
<City>sample string 7</City>
<ContactId>3</ContactId>
<IsPrimary>true</IsPrimary>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<PostalCode>sample string 8</PostalCode>
<State>
<Abbreviation>sample string 4</Abbreviation>
<IsActive>true</IsActive>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<Name>sample string 3</Name>
<OrganizationId>2</OrganizationId>
<StateId>1</StateId>
</State>
<StreetAddress1>sample string 5</StreetAddress1>
<StreetAddress2>sample string 6</StreetAddress2>
<UnitId>2</UnitId>
</Address>
<Address>
<AddressId>1</AddressId>
<AddressType>
<AddressTypeId>1</AddressTypeId>
<CreateDate>2026-04-04T00:30:13.8434118-07:00</CreateDate>
<CreateUserId>6</CreateUserId>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<IsSystemDefined>true</IsSystemDefined>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<ModifyDate>2026-04-04T00:30:13.8434118-07:00</ModifyDate>
<ModifyUserId>7</ModifyUserId>
<OrganizationId>2</OrganizationId>
</AddressType>
<City>sample string 7</City>
<ContactId>3</ContactId>
<IsPrimary>true</IsPrimary>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<PostalCode>sample string 8</PostalCode>
<State>
<Abbreviation>sample string 4</Abbreviation>
<IsActive>true</IsActive>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<Name>sample string 3</Name>
<OrganizationId>2</OrganizationId>
<StateId>1</StateId>
</State>
<StreetAddress1>sample string 5</StreetAddress1>
<StreetAddress2>sample string 6</StreetAddress2>
<UnitId>2</UnitId>
</Address>
</ArrayOfAddress>