Developer Guide
Back to DigiFi Homepage

Search Application Communications

get
https://api.cloud.digifi.io/communications/search

The Search Communications API can be used to search for existing application communications.

This API uses query parameters (no JSON body). Below please find descriptions of the parameters.

Query Params
number
1 to 100
Defaults to 20

Number of entities to return. Used for pagination implementation. If no value is provided used default 20. Max 100.

number
≥ 0

Number entities to skip. Useful for pagination implementation. Only works if count param is passed

string
enum

Field to sort by

Allowed:
string
enum

Direction of sort results. asc or desc

Allowed:
string

Search query to perform

communicationType
array of strings

Array of communication types

communicationType
string

Application ID

string

Product ID

borrowerIds
array of strings

Array of borrower IDs (maximum 100 values in array)

borrowerIds
string

Intermediary ID

string

Record date from in ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) format.

string

Record date to in ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) format.

createdBy
array of strings

Created by user IDs (maximum 100 values in array)

createdBy
Headers
string
enum
Defaults to 2024-02-26
Allowed:
Responses

Updated 5 months ago

Language
Credentials
Header
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago