Skip to main content

Search Contacts

POST 

/contacts/search

> The contacts search endpoint is only available on the Propeller cloud version.

Retrieves a list of contacts by using the search fields below. Results will be paginated.

FieldType
debtorIds (deprecated)array(string)
dateCreatedDateFilter
dateModifiedDateFilter
offsetinteger
pageinteger

Date filter

A date filter is a special date search object that can search through a range:

{
"from": "2020-12-12T00:00:00",
"to": "2022-12-12T00:00:00"
}

Request

Responses

Search Contacts - 200

Response Headers
    Alt-Svc
    Via
    alt-svc
    content-length
    date
    return-format
    x-request-id