Find Contacts by query string
Header Parameters
Authorizationstring
Query Parameters
query_stringstring
A Lucene-style search query
Default value
*
pageinteger
If a query returns multiple pages (total records/size) you can use this value to select a specific page to return. Defaults to zero.
Default value
0
sizeinteger
Number of records per page.
Minimum
1
Maximum
1000
Default value
25
sortstring
Sorting criteria in the format: non-analysed field name (i.e. "lastName.keyword") + direction (asc / desc) Default sort order is ascending.
Default value
lastName.keyword
Response
200
Object
A list of contacts
Response Attributes
itemsarray
Show child attributes
nextobject
Show child attributes
notestring
Warning or informational note about the response if any.
prevobject
Show child attributes
total_countinteger
Total number of items.
400
Object
400 (Bad Request)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object
401 (Unauthorized)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object
403 (Forbidden)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object
500 (Internal Server Error)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?
Response
Was this section helpful?