Qodex.ai

List of Contacts

GET {{baseUrl}}/contacts?offset={{offset}}&limit={{limit}}&relationships=false

Returns the list of all contacts for a firm

Query Parameters

Form ParametertypeMandatoryDescription
offsetnumberRequiredExample = 0
limitnumberRequiredExample = 500
relationshipsOptionalTrue/False - Include contact relationships

Response Body

Returns a list of object as defined below

KeyDatatypeMandatoryConstraints
idNumberYes
contactTypeStringYesMust be one of 'People'/'Company'/Other Entity’/’Joint Member’
firstNameStringYesOnly mandatory if the contactType is 'People'
middleNameStringNoOnly allowed if contactType is 'People'
lastNameStringYesOnly mandatory if the contactType is 'People'
nameStringYesOnly mandatory if the contactType is 'Company'/'Other Entity'
addressIdNumberYesWill be ignored if the contactType is 'People'. Must be a valid existing addressId
representativeIdsList of NumbersYesOnly mandatory if the contactType is 'Joint Member'. Can only contain contactIds of non Joint Members
titleStringNoOnly allowed if contactType is 'People'
sexStringNoOnly allowed if contactType is 'People'. Must be one of 'Male'/'Female'
emailStringNo
mobileStringNo
phone1StringNo
phone2StringNo
taxNumberStringNo
birthdayStringNoOnly allowed if contactType is 'People'. ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601
birthPlaceStringNoOnly allowed if contactType is 'People'
birthStateStringNoOnly allowed if contactType is 'People'. Must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT'/'Foreign'
birthCountryStringNoOnly allowed if contactType is 'People'. ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166
skypeStringNoOnly allowed if contactType is 'People'
companyNumberStringNoOnly allowed if the contactType is one of 'Company'/'Other Entity'
businessNumberStringNoOnly allowed if the contactType is one of 'Company'/'Other Entity'
placeOfIncorportaionStringNoOnly allowed if the contactType is one of 'Company'/'Other Entity'. ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166
incorporationDateStringNoOnly allowed if the contactType is one of 'Company'/'Other Entity'. ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601
typeStringNoOnly allowed if the contactType is 'Other Entity'. Must be one of ‘OTHER', 'SMSF', 'PARTNERSHIP' and 'TRUST' Wll only appear for Other Entity contacts
nationalityStringNoISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 e.g AU
relationshipsArrayNo

Relationships array

KeyDatatypeComment
endDateDate
parentIdString
parentTypeString
startDateDate
typeString

Additional keys

KeyDatatypeMandatoryConstraints
offsetNumberYes
limitNumberYes
totalNumberYes

Request Params

KeyDatatypeRequiredDescription
offsetstring
limitstring
relationshipsboolean[optional] response will not include relationships if parameter not used

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"contacts":[{"addressId":1994,"birthCountry":"SOUTH AFRICA","birthPlace":"Gregoria","birthState":"Foreign","birthday":"1970-07-01","businessNumber":null,"companyNumber":null,"contactType":"People","email":null,"firstName":"Jeevan","id":3760,"incorporationDate":null,"lastName":"Tokhi","mobile":null,"name":"Jeevan Tokhi","phone1":null,"phone2":null,"placeOfIncorporation":null,"representativeIds":null,"sex":null,"skype":null,"taxNumber":null,"title":null,"nationality":"AUSTRALIAN"},{"addressId":1995,"birthCountry":"AUSTRALIA","birthPlace":"FERNEY","birthState":"QLD","birthday":"1952-09-09","businessNumber":null,"companyNumber":null,"contactType":"People","email":null,"firstName":"John","id":3761,"incorporationDate":null,"lastName":"Smith","mobile":null,"name":"John Smith","phone1":null,"phone2":null,"placeOfIncorporation":null,"representativeIds":null,"sex":"Male","skype":null,"taxNumber":null,"title":"Mr","nationality":"AUSTRALIAN"}],"limit":500,"offset":0,"total":2}