Projects API

Owned by Matt Kepple
Last updated: Apr 19, 2022
2 min read

 

Introduction

  • The majority of what happens on Makerble takes place within a project

  • Every story belongs to a single project

  • Every project belongs to a single charity

  • Users can be part of several projects

  • A user can have up to three Roles on a project (although in practice they usually only have one due to the design of the front-end)

    • Editor (called Manager in the front-end) = administrative capabilities

    • Reporter = read & write

    • Observer = read only

  • Front-end documentation of users' project roles (Note: users are often referred to as Colleagues in the front-end)

API Documentation

Projects

Desc: Get all projects

url: /projects

params: default params

response example: default response example (multiple records)

 

 

Desc: Get a single project

url: /projects/:id

response example: default response example (single record)

 

Desc: add users in project

This lets you add users to a project by giving them one or more roles. A user can have up to three roles on a project:

  • Editor (Manager in the front end) has administrative privileges to edit the project and add/remove users

  • Reporter: has permission to create stories in that project

  • Observer: has read only ability to view stories in that project

 

url: /api/v2/projects/add_colleague.json

params:

{
"role_data": [
{
"project_id": 619,
"editor_ids": [559],
"reporter_ids": [560],
"observer_ids": [560]
}
]
}

 

See the Beneficiary Categories assigned to a project

Every project has at least one Beneficiary Category (or Custom Form for Contacts) that is assigned to it. There beneficiary category (or custom Form for Contacts) contains the fields that are used to create the beneficiary record.

  • The API for Custom form for Contacts functionality is currently only used via the Integrations Page on Makerble.

  • This documentation relates to Beneficiary Categories