get https://api.fundraisingbox.com/v1/communications.json
Returns a collection of communication entries that fit a given criteria.
PaginationMaximum is 100 entries, use the page parameter to get the next results.
(with pagination: /communications.json?page={page_number})
Filter by criteria
Example:
GET /communications.json?message={value}&page={page_number}
Returns a collection of communications that fits the given criteria.
These criteria are currently available:
| Criterion | Description | Type |
|---|---|---|
| search_id | The ID of a smart search | integer |
| message | Message contains given substring | string |
| subject | Subject contains given substring | string |
| type | Type of the communication | Enum("note", "email", "phone", "talk", "letter") |
| direction | Direction of the communication | Enum("in", "out") |
| category | Category of the communication | Enum("donation_thank_you", "double_opt_in", "fundraising_page_mail", "gift_donation_certificate") |
| is_system | Whether the communication was created by the FundraisingBox or a user | boolean |
| fb_person_id | ID of the contact to which communication is associated | integer |
| has_attachment | Whether the communication has an attachment | boolean |
| date_min | Minimum creation date | date |
| date_max | Maximum creation date | date |
| created_time_min | Minimum creation date / time | datetime |
| created_time_max | Maximum creation date / time | datetime |
| ids | List of IDs | array<integer> |