Get Contact list or Search Contact

This operation retrieves a list of contacts or searches for specific contacts based on the provided filters.

SecuritybearerAuth
Request
query Parameters
skip
integer

The number of records to skip for pagination. Default is 0.

Example: skip=0
limit
integer

The maximum number of records to return. Default is 20.

Example: limit=20
sort
string
Default: "name:asc"

Specifies the sorting criteria for the returned list.
Use name:asc for ascending or name:desc for descending order based on the contact name.

searchBy
string

Search contacts using default, name, company, email, otherNames, countryCode, street, city, state, postalCode, phone, uniqueID

Example: searchBy=name:John
filterBy
string

Filter with order [begins ,contains, ends] on name, company fields and contactType ALL, SENDER, RECIPIENT.

Example: filterBy=name:begins&contactType:ALL
Responses
200

The Contact list has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

404

The requested resource was not found.

500

The request could not be completed due to an internal error.

get/api/v1/contact/search
Request samples 
Response samples 
application/json
[
  • {
    }
]