Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

...

Beneficiaries (aka contacts)

Desc: Get all viewable contact details

Latest changes: now includes avatar and custom fields

url: /beneficiaries

params: default params

...

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":

...

237 },

...

"project_ids": [

...

572],

...

"custom_fields":

...

[{"173": "3256895684"}], "beneficiary_category_ids": [

...

sub_ratio_ids: [21,32,21,43]

294] }

response example: default response example (single record)

 

Desc: Get all advanced custom fields

url: beneficiaries/advanced_custom_fields

...

response example: default response example (multiple records)

 

Desc: Get all impact box data

url: /beneficiaries/impact_box_data

...