v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB
Entity

Gets all contacts

The optional name parameter returns contacts that contain matching text in the Contact Forename, Contact Middle Name or Contact Surname fields in Infinity

The optional socialMediaUrl parameter returns contacts that contain matching text in the Contact LinkedIn Url, Contact Xing Url, Contact Facebook Profile Url or Contact Twitter Profile Url fields in Infinity

The limit and offset Parameters can be used for paging purposes.

When supplied, the limit value should be greater than or equal to one. If the value is omitted, zero or a negative number then all results after the offset will be returned.

When supplied, the offset should be greater than or equal to zero. If the value is omitted or a negative number then results will start from the first page.

Results are ordered by LastUpdated date in descending order

get/Entity/Contacts

Query parameters

lastUpdatedSincestring date-time nullable

Optionally filter contacts updated since a specific date and time

namestring nullable

Optionally filter contacts that have a matching name

phonestring nullable

Optionally filter contacts that have a matching phone number

emailstring nullable

Optionally filter contacts that have a matching email

socialMediaUrlstring nullable

Optionally filter contacts that have a matching social media url

townstring nullable

Optionally filter contacts that have a matching location town name

limitinteger nullable

Optionally limit the number of results to return in one request.

offsetinteger nullable

Optionally set the number of results to skip before returning the results.

Response

Idinteger required
Forenamestring required
MiddleNamestring required
Surnamestring required
LinkedInUrlstring required
XingUrlstring required
FacebookProfileUrlstring required
TwitterProfileUrlstring required
IsActiveboolean required
Createdstring date-time required
LastUpdatedstring date-time required