Get contacts

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Query Parameters

Offset

integer<int32>

Required range: 0 <= x <= 2147483647

Limit

integer<int32>

Required range: 1 <= x <= 500

UpdatedSince

integer<int64>

Returns contacts updated since a specified time (.net ticks representation of the UTC datetime).

ExcludeDeletedContacts

boolean

Excludes (filters out) deleted contacts if set to true.

Example:

true

Type

string[]

Filters result by one more contact types if set. Returns all contact types by default. Possible values: Staff, Person, Organisation, GroupOfPeople, Trust

string[]

Available fields: email, phone, name

Sort

string

Available fields: lastUpdated

Fields

string

Available fields: passportDetails, deathDetails, citizenshipDetails, utbmsDetails, tags

Response

200 - application/json

When request is successful. Returns a paged collection of 'Contact' objects.

string | null

href

string | null

relation

string | null

method

string | null

default:GET

self

object

Show child attributes

self.id

string | null

self.href

string | null

self.relation

string | null

self.method

string | null

default:GET

value

object[] | null

Show child attributes

value.href

string | null

value.relation

string | null

value.method

string | null

default:GET

value.self

object

Show child attributes

value.self.id

string | null

value.self.href

string | null

value.self.relation

string | null

value.self.method

string | null

default:GET

value.id

string | null

Unique identifier of the contact.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

value.externalSystemId

string | null

External system id for the contact.

Example:

"EXT01"

value.versionId

string | null

Version id of the record.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

value.person

object

Contact person details (if applicable).

Show child attributes

value.person.title

string | null

Contact person's title. Accepts custom values.

e.g. Mr, Mrs, Miss, Honourable, Judge.

Example:

"Mr"

value.person.firstName

string | null

Contact person's first name.

Example:

"John"

value.person.middleName

string | null

Contact person's middle name (if applicable).

Example:

"Michael"

value.person.lastName

string | null

Contact person's last name.

Example:

"Smith"

value.person.nameSuffix

string | null

Contact person's name suffix (if applicable).

Example:

"PhD"

value.person.customName

string | null

Contact person's custom name to be used in letters (if applicable).

Example:

"Johnny"

value.person.residentialAddress

object

Contact person's residential address details.

Show child attributes

value.person.residentialAddress.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.person.residentialAddress.buildingLevel

string | null

Building level in address (if applicable).

Example:

"Level 1"

value.person.residentialAddress.unitNumber

string | null

Unit number in address (if applicable).

Example:

"10"

value.person.residentialAddress.unitType

string | null

Unit type in address (if applicable). Accepts custom values.

e.g. Apartment, Unit, Flat, Villa, Suite.

Example:

"Suite"

value.person.residentialAddress.streetNumber

string | null

Street number in address.

Example:

"100"

value.person.residentialAddress.streetName

string | null

Street name in address.

Example:

"Broad"

value.person.residentialAddress.streetType

string | null

Street type. Accepts custom values.

e.g. Street, Road, Avenue, Lane.

Example:

"Street"

value.person.residentialAddress.addressLine1

string | null

First line of address.

Example:

"Level 1/10"

value.person.residentialAddress.addressLine2

string | null

Second line of address (if applicable).

Example:

"100 Broad Street"

value.person.residentialAddress.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.person.residentialAddress.state

string | null

State, province, or region.

Example:

"IL"

value.person.residentialAddress.zipCode

string | null

Zip or post code.

Example:

"60606"

value.person.residentialAddress.locality

string | null

Locality.

Only supported in the UK.

Example:

"Dunkirk"

value.person.residentialAddress.county

string | null

County.

Only supported in the US and UK.

Example:

"New York"

value.person.residentialAddress.country

string | null

Country.

Example:

"United States"

value.person.residentialAddress.poBox

object

PO Box details (if applicable).

Show child attributes

value.person.residentialAddress.poBox.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.person.residentialAddress.poBox.poBoxType

string | null

PO Box type. Accepts custom values.

e.g. Care PO, PO Box, Locked Bag, RMS.

Example:

"Locked Bag"

value.person.residentialAddress.poBox.poBoxNumber

string | null

PO Box number.

Example:

"12345"

value.person.residentialAddress.poBox.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.person.residentialAddress.poBox.state

string | null

State, province, or region.

Example:

"IL"

value.person.residentialAddress.poBox.zipCode

string | null

Zip or post code.

Example:

"60606"

value.person.mailingAddress

object

Contact person's mailing address details.

Only supported in the US.

Show child attributes

value.person.mailingAddress.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.person.mailingAddress.buildingLevel

string | null

Building level in address (if applicable).

Example:

"Level 1"

value.person.mailingAddress.unitNumber

string | null

Unit number in address (if applicable).

Example:

"10"

value.person.mailingAddress.unitType

string | null

Unit type in address (if applicable). Accepts custom values.

e.g. Apartment, Unit, Flat, Villa, Suite.

Example:

"Suite"

value.person.mailingAddress.streetNumber

string | null

Street number in address.

Example:

"100"

value.person.mailingAddress.streetName

string | null

Street name in address.

Example:

"Broad"

value.person.mailingAddress.streetType

string | null

Street type. Accepts custom values.

e.g. Street, Road, Avenue, Lane.

Example:

"Street"

value.person.mailingAddress.addressLine1

string | null

First line of address.

Example:

"Level 1/10"

value.person.mailingAddress.addressLine2

string | null

Second line of address (if applicable).

Example:

"100 Broad Street"

value.person.mailingAddress.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.person.mailingAddress.state

string | null

State, province, or region.

Example:

"IL"

value.person.mailingAddress.zipCode

string | null

Zip or post code.

Example:

"60606"

value.person.mailingAddress.locality

string | null

Locality.

Only supported in the UK.

Example:

"Dunkirk"

value.person.mailingAddress.county

string | null

County.

Only supported in the US and UK.

Example:

"New York"

value.person.mailingAddress.country

string | null

Country.

Example:

"United States"

value.person.mailingAddress.poBox

object

PO Box details (if applicable).

Show child attributes

value.person.mailingAddress.poBox.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.person.mailingAddress.poBox.poBoxType

string | null

PO Box type. Accepts custom values.

e.g. Care PO, PO Box, Locked Bag, RMS.

Example:

"Locked Bag"

value.person.mailingAddress.poBox.poBoxNumber

string | null

PO Box number.

Example:

"12345"

value.person.mailingAddress.poBox.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.person.mailingAddress.poBox.state

string | null

State, province, or region.

Example:

"IL"

value.person.mailingAddress.poBox.zipCode

string | null

Zip or post code.

Example:

"60606"

value.person.phone

object

Contact person's phone details.

Show child attributes

value.person.phone.areaCode

string | null

Phone area code.

Example:

"555"

value.person.phone.number

string | null

Phone number (excluding area code).

Example:

"1234567"

value.person.phone2

object

Contact person's alternate phone details.

Show child attributes

value.person.phone2.areaCode

string | null

Phone area code.

Only supported in the US.

Example:

"555"

value.person.phone2.number

string | null

Phone number (excluding area code).

Example:

"1234567"

value.person.phone2.extension

string | null

Phone number extension.

Example:

"103"

value.person.fax

object

Contact person's fax details.

Only supported in the US.

Show child attributes

value.person.fax.areaCode

string | null

Phone area code.

Example:

"555"

value.person.fax.number

string | null

Phone number (excluding area code).

Example:

"1234567"

value.person.cell

object

Contact person's mobile details.

Show child attributes

value.person.cell.areaCode

string | null

Phone area code.

Example:

"555"

value.person.cell.number

string | null

Phone number (excluding area code).

Example:

"1234567"

value.person.email

string | null

Contact person's email address.

Example:

"[email protected]"

value.person.notes

string | null

Additional notes about contact (if applicable).

Example:

"Prefers to answer work phone."

value.person.occupation

string | null

Contact person's occupation.

Example:

"Bookkeeper"

value.person.gender

string | null

Contact person's gender.

Accepted values - Male, Female, Other as well as any free text.

Example:

"Male"

value.person.maritalStatus

string | null

Contact person's marital status. Accepts custom values.

e.g. Single, Married, Separated, Divorced, Widowed, De facto.

Example:

"Single"

value.person.specialNeeds

string | null

Brief description of any special needs (if applicable).

Only supported in Australia.

Example:

"Wheelchair access"

value.person.birthDate

string<date-time> | null

Contact person's date of birth.

Example:

"1980-07-01"

value.person.birthPlace

string | null

Contact person's place of birth.

Example:

"Chicago"

value.person.birthState

string | null

Contact person's birth state.

Example:

"Illinois"

value.person.birthCountry

string | null

Contact person's birth country.

Example:

"USA"

value.person.identificationNumberType

string | null

Contact person's type of identification.

Example:

"Passport"

value.person.identificationNumber

string | null

Contact person's identification number.

Example:

"PP123456789"

value.person.birthFirstName

string | null

Contact person's first name at birth.

Example:

"James"

value.person.birthMiddleName

string | null

Contact person's middle name at birth.

Example:

"Thomas"

value.person.birthLastName

string | null

Contact person's last name at birth.

Example:

"Jones"

value.person.previousNames

string | null

Contact person's previous names.

Example:

"Jane Smith"

value.person.passportDetails

object

Contact person's passport details.

Show child attributes

value.person.passportDetails.passportNumber

string | null

Contact person's passport number.

Example:

"AB123456"

value.person.passportDetails.passportIssueDate

string<date-time> | null

Contact person's passport issue date.

Example:

"2010-08-01"

value.person.passportDetails.passportExpireDate

string<date-time> | null

Contact person's passport expiry date.

Example:

"2030-08-01"

value.person.passportDetails.passportIssueCountry

string | null

Contact person's passport country of issue.

Example:

"USA"

value.person.passportDetails.passportIssueAuthority

string | null

Contact person's passport issuing authority.

Only supported in the UK.

Example:

"HM Passport Office"

value.person.deathDetails

object

Contact person's death details.

Show child attributes

value.person.deathDetails.deathDate

string<date-time> | null

Contact person's date of death.

Example:

"2020-08-01"

value.person.deathDetails.isDeathDateUnknown

boolean

Whether the person's exact date of death is known.

Example:

false

value.person.deathDetails.deathDateFrom

string<date-time> | null

Starting range for person's possible date of death.

Example:

"2020-08-01"

value.person.deathDetails.deathDateTo

string<date-time> | null

Ending range for person's possible date of death.

Example:

"2020-08-01"

value.person.deathDetails.deathPlace

string | null

Contact person's place of death.

Example:

"Chicago"

value.person.deathDetails.deathState

string | null

Contact person's death state.

Only supported in AU and US.

Example:

"IL"

value.person.deathDetails.deathCountry

string | null

Contact person's death country.

Example:

"USA"

value.person.deathDetails.deathCounty

string | null

Contact person's death county.

Only supported in US.

Example:

"San Bernardino County"

value.person.correctionsReferenceNumber

string | null

Contact person's corrections reference number.

Only supported in Australia.

value.person.centrelinkReferenceNumber

string | null

Contact person's centrelink reference number.

Only supported in Australia.

value.person.citizenshipDetails

object

Contact person's citizenship details.

Show child attributes

value.person.citizenshipDetails.countryOfCitizenship

string | null

Country of citizenship

Example:

"USA"

value.person.citizenshipDetails.nationality

string | null

Nationality

Example:

"American"

value.person.citizenshipDetails.languageOfInterpreter

string | null

Language of interpreter

Example:

"French"

value.person.utbmsDetails

object

Contact's UTBMS Details.

Only supported in the US.

Show child attributes

value.person.utbmsDetails.ledesClientId

string | null

LEDES client Id

value.company

object

Contact company details (if applicable).

Show child attributes

value.company.name

string | null

Company's name.

Example:

"Brown LLC"

value.company.type

string | null

Company's type.

Possible values for US: 'Corporation', 'Government Agency', 'Limited Liability Company', 'Sole Proprietor', 'Partnership', 'Not-for-Profit'

Possible values for AU: 'Company', 'Sole Proprietor', 'Partnership', 'Government Department'

Possible values for UK: 'Company', 'Sole Trader', 'Partnership', 'Limited Liability Partnership', 'Government Department'

Example:

"Corporation"

value.company.phone

object

Company's phone details.

Show child attributes

value.company.phone.areaCode

string | null

Phone area code.

Example:

"555"

value.company.phone.number

string | null

Phone number (excluding area code).

Example:

"1234567"

value.company.fax

object

Company's fax details.

Show child attributes

value.company.fax.areaCode

string | null

Phone area code.

Example:

"555"

value.company.fax.number

string | null

Phone number (excluding area code).

Example:

"1234567"

value.company.email

string | null

Company's email address.

Example:

"[email protected]"

value.company.notes

string | null

Additional notes for company (if applicable).

Example:

"Construction company"

value.company.abn

string | null

For AU: Australian Company Number (ABN) of the firm.

For UK: Company Registration Number (CRN) of the firm.

Only supported in AU and UK.

Example:

"1234567890"

value.company.companyNumberType

string | null

Company's Australian company number type.

Accepted values - ACN, ARBN

Only supported in AU.

Example:

"ACN"

value.company.companyNumber

string | null

Company's Australian Company Number.

Only supported in AU.

Example:

"234567890"

value.company.mailingAddress

object

Company's mailing address details.

Show child attributes

value.company.mailingAddress.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.company.mailingAddress.buildingLevel

string | null

Building level in address (if applicable).

Example:

"Level 1"

value.company.mailingAddress.unitNumber

string | null

Unit number in address (if applicable).

Example:

"10"

value.company.mailingAddress.unitType

string | null

Unit type in address (if applicable). Accepts custom values.

e.g. Apartment, Unit, Flat, Villa, Suite.

Example:

"Suite"

value.company.mailingAddress.streetNumber

string | null

Street number in address.

Example:

"100"

value.company.mailingAddress.streetName

string | null

Street name in address.

Example:

"Broad"

value.company.mailingAddress.streetType

string | null

Street type. Accepts custom values.

e.g. Street, Road, Avenue, Lane.

Example:

"Street"

value.company.mailingAddress.addressLine1

string | null

First line of address.

Example:

"Level 1/10"

value.company.mailingAddress.addressLine2

string | null

Second line of address (if applicable).

Example:

"100 Broad Street"

value.company.mailingAddress.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.company.mailingAddress.state

string | null

State, province, or region.

Example:

"IL"

value.company.mailingAddress.zipCode

string | null

Zip or post code.

Example:

"60606"

value.company.mailingAddress.locality

string | null

Locality.

Only supported in the UK.

Example:

"Dunkirk"

value.company.mailingAddress.county

string | null

County.

Only supported in the US and UK.

Example:

"New York"

value.company.mailingAddress.country

string | null

Country.

Example:

"United States"

value.company.mailingAddress.poBox

object

PO Box details (if applicable).

Show child attributes

value.company.mailingAddress.poBox.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.company.mailingAddress.poBox.poBoxType

string | null

PO Box type. Accepts custom values.

e.g. Care PO, PO Box, Locked Bag, RMS.

Example:

"Locked Bag"

value.company.mailingAddress.poBox.poBoxNumber

string | null

PO Box number.

Example:

"12345"

value.company.mailingAddress.poBox.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.company.mailingAddress.poBox.state

string | null

State, province, or region.

Example:

"IL"

value.company.mailingAddress.poBox.zipCode

string | null

Zip or post code.

Example:

"60606"

value.company.businessAddress

object

Company's business address details.

Show child attributes

value.company.businessAddress.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.company.businessAddress.buildingLevel

string | null

Building level in address (if applicable).

Example:

"Level 1"

value.company.businessAddress.unitNumber

string | null

Unit number in address (if applicable).

Example:

"10"

value.company.businessAddress.unitType

string | null

Unit type in address (if applicable). Accepts custom values.

e.g. Apartment, Unit, Flat, Villa, Suite.

Example:

"Suite"

value.company.businessAddress.streetNumber

string | null

Street number in address.

Example:

"100"

value.company.businessAddress.streetName

string | null

Street name in address.

Example:

"Broad"

value.company.businessAddress.streetType

string | null

Street type. Accepts custom values.

e.g. Street, Road, Avenue, Lane.

Example:

"Street"

value.company.businessAddress.addressLine1

string | null

First line of address.

Example:

"Level 1/10"

value.company.businessAddress.addressLine2

string | null

Second line of address (if applicable).

Example:

"100 Broad Street"

value.company.businessAddress.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.company.businessAddress.state

string | null

State, province, or region.

Example:

"IL"

value.company.businessAddress.zipCode

string | null

Zip or post code.

Example:

"60606"

value.company.businessAddress.locality

string | null

Locality.

Only supported in the UK.

Example:

"Dunkirk"

value.company.businessAddress.county

string | null

County.

Only supported in the US and UK.

Example:

"New York"

value.company.businessAddress.country

string | null

Country.

Example:

"United States"

value.company.businessAddress.poBox

object

PO Box details (if applicable).

Show child attributes

value.company.businessAddress.poBox.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.company.businessAddress.poBox.poBoxType

string | null

PO Box type. Accepts custom values.

e.g. Care PO, PO Box, Locked Bag, RMS.

Example:

"Locked Bag"

value.company.businessAddress.poBox.poBoxNumber

string | null

PO Box number.

Example:

"12345"

value.company.businessAddress.poBox.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.company.businessAddress.poBox.state

string | null

State, province, or region.

Example:

"IL"

value.company.businessAddress.poBox.zipCode

string | null

Zip or post code.

Example:

"60606"

value.company.businessAddress.dxAddress

object

DX address details (only applicable for AUS).

Show child attributes

value.company.businessAddress.dxAddress.number

string | null

Direct Exchange number (if applicable).

Example:

"376"

value.company.businessAddress.dxAddress.exchange

string | null

Direct Exchange name.

Example:

"DX"

value.company.businessAddress.dxAddress.state

string | null

State, province, or region.

Example:

"NSW"

value.company.staff

object[] | null

Company's staff hypermedia links.

Show child attributes

value.company.staff.id

string | null

value.company.staff.href

string | null

value.company.staff.relation

string | null

value.company.staff.method

string | null

default:GET

value.company.directors

object[] | null

Company's directors hypermedia links.

Show child attributes

value.company.directors.id

string | null

value.company.directors.href

string | null

value.company.directors.relation

string | null

value.company.directors.method

string | null

default:GET

value.company.staffIds

string[] | null

Deprecated - use Staff instead. This field may not be supported in future.

value.trust

object

Contact trust details (if applicable).

Note that Trust is only supported in the US. It is not available in other regions.

Show child attributes

value.trust.name

string | null

Trust's name.

Example:

"Trinity Trust"

value.trust.status

string | null

Trust's status.

Standard values are: as Trustee of, as Trustees of, as Co-Trustees of, as an Individual and as Trustee of, as Successor Trustee of. A custom value can be supplied instead.

Example:

"as Trustee of"

value.trust.trustNumber

string | null

Trust's number.

Example:

"12345678"

value.trust.executedDate

string<date-time> | null

Date trust was executed.

Example:

"1980-07-01"

value.trust.phone

object

Trust's phone details.

Show child attributes

value.trust.phone.areaCode

string | null

Phone area code.

Example:

"555"

value.trust.phone.number

string | null

Phone number (excluding area code).

Example:

"1234567"

value.trust.fax

object

Trust's fax details.

Show child attributes

value.trust.fax.areaCode

string | null

Phone area code.

Example:

"555"

value.trust.fax.number

string | null

Phone number (excluding area code).

Example:

"1234567"

value.trust.address

object

Trust's address.

Show child attributes

value.trust.address.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.trust.address.buildingLevel

string | null

Building level in address (if applicable).

Example:

"Level 1"

value.trust.address.unitNumber

string | null

Unit number in address (if applicable).

Example:

"10"

value.trust.address.unitType

string | null

Unit type in address (if applicable). Accepts custom values.

e.g. Apartment, Unit, Flat, Villa, Suite.

Example:

"Suite"

value.trust.address.streetNumber

string | null

Street number in address.

Example:

"100"

value.trust.address.streetName

string | null

Street name in address.

Example:

"Broad"

value.trust.address.streetType

string | null

Street type. Accepts custom values.

e.g. Street, Road, Avenue, Lane.

Example:

"Street"

value.trust.address.addressLine1

string | null

First line of address.

Example:

"Level 1/10"

value.trust.address.addressLine2

string | null

Second line of address (if applicable).

Example:

"100 Broad Street"

value.trust.address.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.trust.address.state

string | null

State, province, or region.

Example:

"IL"

value.trust.address.zipCode

string | null

Zip or post code.

Example:

"60606"

value.trust.address.locality

string | null

Locality.

Only supported in the UK.

Example:

"Dunkirk"

value.trust.address.county

string | null

County.

Only supported in the US and UK.

Example:

"New York"

value.trust.address.country

string | null

Country.

Example:

"United States"

value.trust.address.poBox

object

PO Box details (if applicable).

Show child attributes

value.trust.address.poBox.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.trust.address.poBox.poBoxType

string | null

PO Box type. Accepts custom values.

e.g. Care PO, PO Box, Locked Bag, RMS.

Example:

"Locked Bag"

value.trust.address.poBox.poBoxNumber

string | null

PO Box number.

Example:

"12345"

value.trust.address.poBox.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.trust.address.poBox.state

string | null

State, province, or region.

Example:

"IL"

value.trust.address.poBox.zipCode

string | null

Zip or post code.

Example:

"60606"

value.trust.trustees

object[] | null

List of trustees.

Show child attributes

value.trust.trustees.name

string | null

Trustee's name.

Example:

"John Smith"

value.trust.trustees.type

string | null

Type of trustee.

Standard values are: Company, Individual. A custom value can be supplied instead.

Example:

"Individual"

Example:

[
  {
    "Name": "John Smith",
    "Type": "Individual"
  },
  {
    "Name": "Smithfield Steel",
    "Type": "Company"
  }
]

value.trust.contacts

object[] | null

Trust's contacts hypermedia links.

Show child attributes

value.trust.contacts.id

string | null

value.trust.contacts.href

string | null

value.trust.contacts.relation

string | null

value.trust.contacts.method

string | null

default:GET

value.groupOfPeople

object

Contact group details (if applicable).

Show child attributes

value.groupOfPeople.people

object[] | null

List of contact person hypermedia links.

Show child attributes

value.groupOfPeople.people.id

string | null

value.groupOfPeople.people.href

string | null

value.groupOfPeople.people.relation

string | null

value.groupOfPeople.people.method

string | null

default:GET

value.groupOfPeople.residentialAddress

object

Contact group's residential address details.

Show child attributes

value.groupOfPeople.residentialAddress.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.groupOfPeople.residentialAddress.buildingLevel

string | null

Building level in address (if applicable).

Example:

"Level 1"

value.groupOfPeople.residentialAddress.unitNumber

string | null

Unit number in address (if applicable).

Example:

"10"

value.groupOfPeople.residentialAddress.unitType

string | null

Unit type in address (if applicable). Accepts custom values.

e.g. Apartment, Unit, Flat, Villa, Suite.

Example:

"Suite"

value.groupOfPeople.residentialAddress.streetNumber

string | null

Street number in address.

Example:

"100"

value.groupOfPeople.residentialAddress.streetName

string | null

Street name in address.

Example:

"Broad"

value.groupOfPeople.residentialAddress.streetType

string | null

Street type. Accepts custom values.

e.g. Street, Road, Avenue, Lane.

Example:

"Street"

value.groupOfPeople.residentialAddress.addressLine1

string | null

First line of address.

Example:

"Level 1/10"

value.groupOfPeople.residentialAddress.addressLine2

string | null

Second line of address (if applicable).

Example:

"100 Broad Street"

value.groupOfPeople.residentialAddress.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.groupOfPeople.residentialAddress.state

string | null

State, province, or region.

Example:

"IL"

value.groupOfPeople.residentialAddress.zipCode

string | null

Zip or post code.

Example:

"60606"

value.groupOfPeople.residentialAddress.locality

string | null

Locality.

Only supported in the UK.

Example:

"Dunkirk"

value.groupOfPeople.residentialAddress.county

string | null

County.

Only supported in the US and UK.

Example:

"New York"

value.groupOfPeople.residentialAddress.country

string | null

Country.

Example:

"United States"

value.groupOfPeople.residentialAddress.poBox

object

PO Box details (if applicable).

Show child attributes

value.groupOfPeople.residentialAddress.poBox.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.groupOfPeople.residentialAddress.poBox.poBoxType

string | null

PO Box type. Accepts custom values.

e.g. Care PO, PO Box, Locked Bag, RMS.

Example:

"Locked Bag"

value.groupOfPeople.residentialAddress.poBox.poBoxNumber

string | null

PO Box number.

Example:

"12345"

value.groupOfPeople.residentialAddress.poBox.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.groupOfPeople.residentialAddress.poBox.state

string | null

State, province, or region.

Example:

"IL"

value.groupOfPeople.residentialAddress.poBox.zipCode

string | null

Zip or post code.

Example:

"60606"

value.groupOfPeople.mailingAddress

object

Contact group's mailing address details.

Only supported in the US.

Show child attributes

value.groupOfPeople.mailingAddress.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.groupOfPeople.mailingAddress.buildingLevel

string | null

Building level in address (if applicable).

Example:

"Level 1"

value.groupOfPeople.mailingAddress.unitNumber

string | null

Unit number in address (if applicable).

Example:

"10"

value.groupOfPeople.mailingAddress.unitType

string | null

Unit type in address (if applicable). Accepts custom values.

e.g. Apartment, Unit, Flat, Villa, Suite.

Example:

"Suite"

value.groupOfPeople.mailingAddress.streetNumber

string | null

Street number in address.

Example:

"100"

value.groupOfPeople.mailingAddress.streetName

string | null

Street name in address.

Example:

"Broad"

value.groupOfPeople.mailingAddress.streetType

string | null

Street type. Accepts custom values.

e.g. Street, Road, Avenue, Lane.

Example:

"Street"

value.groupOfPeople.mailingAddress.addressLine1

string | null

First line of address.

Example:

"Level 1/10"

value.groupOfPeople.mailingAddress.addressLine2

string | null

Second line of address (if applicable).

Example:

"100 Broad Street"

value.groupOfPeople.mailingAddress.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.groupOfPeople.mailingAddress.state

string | null

State, province, or region.

Example:

"IL"

value.groupOfPeople.mailingAddress.zipCode

string | null

Zip or post code.

Example:

"60606"

value.groupOfPeople.mailingAddress.locality

string | null

Locality.

Only supported in the UK.

Example:

"Dunkirk"

value.groupOfPeople.mailingAddress.county

string | null

County.

Only supported in the US and UK.

Example:

"New York"

value.groupOfPeople.mailingAddress.country

string | null

Country.

Example:

"United States"

value.groupOfPeople.mailingAddress.poBox

object

PO Box details (if applicable).

Show child attributes

value.groupOfPeople.mailingAddress.poBox.careOf

string | null

Care of the addressee (if applicable).

Example:

"John Smith"

value.groupOfPeople.mailingAddress.poBox.poBoxType

string | null

PO Box type. Accepts custom values.

e.g. Care PO, PO Box, Locked Bag, RMS.

Example:

"Locked Bag"

value.groupOfPeople.mailingAddress.poBox.poBoxNumber

string | null

PO Box number.

Example:

"12345"

value.groupOfPeople.mailingAddress.poBox.city

string | null

City, district, suburb, town, or village.

Example:

"Chicago"

value.groupOfPeople.mailingAddress.poBox.state

string | null

State, province, or region.

Example:

"IL"

value.groupOfPeople.mailingAddress.poBox.zipCode

string | null

Zip or post code.

Example:

"60606"

value.groupOfPeople.name

string | null

Names of the people in the group. Limited to the first 5 names.

Example:

"John Smith & Jane Citizen"

value.isDeleted

boolean

Returns true if the contact is deleted.

Example:

true

value.lastUpdated

integer<int64>

Last updated timestamp.

Example:

637847425252027400

value.tags

object[] | null

Set of contact's tags.

Show child attributes

value.tags.id

string | null

Identifier of the tag. Role tags do not have an identifier.

value.tags.name

string | null

Name of tag.

value.tags.type

string

Type of tag. Accepted values are 'Role' or 'Custom'

Example:

"Custom"

offset

integer<int32> | null

limit

integer<int32> | null

size

integer<int64>

first

object

Show child attributes

first.id

string | null

first.href

string | null

first.relation

string | null

first.method

string | null

default:GET

object

Show child attributes

previous.id

string | null

previous.href

string | null

previous.relation

string | null

previous.method

string | null

default:GET

object

Show child attributes

next.id

string | null

next.href

string | null

next.relation

string | null

next.method

string | null

default:GET

last

object

Show child attributes

last.id

string | null

last.href

string | null

last.relation

string | null

last.method

string | null

default:GET

Documentation

Tutorials

APIs

Authorizations

Query Parameters

Response