Dawood to write intro on beneficiaries
Beneficiaries (aka contacts)
Desc: Get all viewable contact details
Latest changes: now includes avatar and custom fields
url: /beneficiaries
params: default params
additional params:
charity_id: 123 (default null)
project_id: 431 (default null)
response example: default response example (multiple records)
Desc: Get a single contact
Latest changes: now includes avatar and custom fields
url: /beneficiaries/:id
response example: default response example (single record)
Desc: Post a single contact
url: /beneficiaries
method: POST
required: owner_id, name
body: {
beneficiary: {name: “Jack“, date_of_birth: “13-05-1899“, address: “Paris“, latitude: “48.856613“, longitude: “2.352222“, beneficiary_type_id: 1, owner_id: 213},
project_ids: [2,12],
custom_fields: {“12“ => “Coffee“, “22” => “Yes“},
beneficiary_category_ids: [1,21,32],
sub_ratio_ids: [21,32,21,43]
}
response example: default response example (single record)
Desc: Get all advanced custom fields
url: beneficiaries/advanced_custom_fields
params: default params
response example: default response example (multiple records)
Desc: Get all impact box data
url: /beneficiaries/impact_box_data
params: default params
response example: default response example (multiple records)