Get a single contact API (Beneficiary)

Introduction

  • Beneficiary is the back-end term for what in the front-end is called a Contact

  • The screenshot below is a typical Contact Profile Page on Makerble for a contact called Abigail Holmes

  • The red section is her Bio. It contains

    • Default fields: Name, profile picture, address, date of birth

    • Unlimited custom fields, e.g. Marital status etc.

  • The purple section is her Timeline. It contains stories that she is tagged in.

API Documentation

  • Endpoint: GET /api/v2/beneficiaries/:id

  • Authentication: Requires valid authentication token

  • Response Format: JSON

  • Query Parameter

    • id (integer): The unique identifier for the beneficiary

Response Attributes

  • id (integer): The unique identifier for the beneficiary.

  • name (string): The name of the beneficiary.

  • dob (string, format: "YYYY-MM-DD"): Date of birth of the beneficiary.

  • charity_id (integer): The identifier of the associated charity.

  • mobile (string): Mobile number of the beneficiary (if available).

  • email (string): Email address of the beneficiary.

  • address (string): Residential address of the beneficiary.

  • avatar (string): URL or path to the beneficiary's avatar (if available).

  • created_by (integer): The identifier of the user who created the beneficiary record.

  • updated_at (string): Timestamp of last update.

  • created_at (string): Timestamp of creation.

  • custom_fields (array): custom fields associated with the beneficiary

    • id (integer): Custom field ID.

    • name (string): Name of the custom field.

    • type (string): Type of the custom field.

    • value (string): Value of the custom field.

 

 

 

  

Front-end Documentation

  • Beneficiaries are called Contacts in the front-end