#Search contacts

Search contacts by partial/full name or phone number.

#Method

GET

#Path

/contacts/search

#Query string parameter

NameValueRequired?
querySearch term (either partial/full name or phone number). Search is case insensitive. Minimum 2 characters are required.Yes
limitNumber of records to return. Max allowed value is 20.No. Defaults to 20.
offsetNumber of records to skip (for pagination).No. Defaults to 0.

#Response

#HTTP status codes

CodeRemarks
200Request was successful.
400Validation error or request body was incorrectly formatted.
401Authentication failed. Check apikey header.
404Requested API endpoint not found.
429The rate limit has been reached.
500-511There was a problem processing the request on our server. Try again later.

#Response object

NameValueRemarks
statussuccess or error-
errorsArray of object { msg: [error detail] }Only present when status is error.
dataArray of contact objects. Result is sorted by relevance of the match.Only present when status is success

#Code sample

curl --location --request GET 'https://api.sociocs.com/contacts/search?query=Emilia&limit=10&offset=0' \ --header 'apikey: your_api_key' \