Appearance
Search contacts
GET
/api/nova/contacts/search
Searches contacts using a free-text query and returns a paginated list. Accepts query (defaults to empty, which matches all contacts), page (default 0) and size (default 20, capped at 100) parameters. Results are sorted by creation date, newest first. The response contains the matching contact records plus page, size and total count metadata. Returns 401 for an invalid API key.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "alternateEmail": "string", "companyId": "string", "companyName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "description": "string", "doNotContact": true, "email": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industries": [ "string" ], "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "reference": "string", "secondaryCompanyId": "string", "secondaryCompanyName": "string", "sectors": [ "string" ], "skills": [ "string" ], "skype": "string", "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "workPhone": "string" } ], "error": "string", "message": "string", "page": 0, "requestId": "string", "size": 0, "success": true, "total": 0
{
}