/Contacts
  • 18 Jan 2024
  • PDF

/Contacts

  • PDF

Article summary

Get
/Contacts

Retrieve a list of information related to contacts.

Security
Http
Type bearer
Bearer Authorization Token
Query parameters
$select
string
$filter
string
$expand
string
$orderby
string
$skip
string
$top
string
$pageNumber
string
$limit
string
Responses
200

Success

Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0
Array of object
object
ContactID
integer (int32)
CompanyID
integer (int32)
CompanyName
string
Max length100
Min length0
ContactTypeID
integer (int32)
ContactTypeName
string
Max length20
Min length0
OfficeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
HomeAddress
object (AspireCloud.Domain.Tenant.Addresses.ODataModel.Address)
AddressID
integer (int32)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
CreatedByUserId
integer (int32)
CreatedOn
string (date-time)
LastModifiedByUserId
integer (int32)
LastModifiedOn
string (date-time)
BranchID
integer (int32)
BranchName
string
Max length50
Min length0
OwnerContactID
integer (int32)
OwnerContactName
string
Max length101
Min length0
Salutation
string
Max length20
Min length0
FirstName
string
Max length50
Min length0
LastName
string
Max length50
Min length0
ProspectRating
string
Max length4
Min length0
ProspectRatingName
string
Max length4
Min length0
Title
string
Max length50
Min length0
Email
string
Max length255
Min length0
MobilePhone
string
Max length25
Min length0
OfficePhone
string
Max length25
Min length0
HomePhone
string
Max length25
Min length0
Fax
string
Max length25
Min length0
Notes
string
Max length2147483647
Min length0
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserID
integer (int32)
CreatedByUserName
string
Max length101
Min length0
EmployeeNumber
string
Max length25
Min length0
Website
string
Max length255
Min length0
EmployeePin
string
Max length50
Min length0
AccountingSyncID
string
ExternalContactReference
string
Max length255
Min length0
TerminationDate
string (date-time)
HRNotes
string
Max length2147483647
Min length0
DefaultWorkersCompID
integer (int32)
DefaultWorkersCompName
string
Max length200
Min length0
DefaultWorkersCompStateProvinceCode
string
Max length3
Min length0
UserID
integer (int32)
CrewSize
integer (int32)
PromptForCrewSize
boolean
SubCrewLeaderContactID
integer (int32)
PayScheduleID
integer (int32)
ModifiedDate
string (date-time)
ContactTags
Array of object (AspireCloud.Domain.Tenant.Contacts.ODataModel.ContactTag)
object
ContactTagID
integer (int32)
TagID
integer (int32)
TagName
string
Max length750
Min length0

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.