Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CCAFS/MARLO/llms.txt

Use this file to discover all available pages before exploring further.

MARLO projects are the primary containers for research activities, budgets, partnerships, and outputs within a CGIAR program. The projects REST controller exposes a single read endpoint that returns a project record by its numeric ID, scoped to a CGIAR entity.
The Projects controller is marked @ApiIgnore in the source, which means it is excluded from the auto-generated Swagger UI. The endpoint is fully functional, but it does not appear in the interactive Swagger documentation at /swagger-ui/.
All endpoints require a valid QA token. See Authentication for details.

​
Get a project by ID

Retrieve a project record by its numeric ID within a CGIAR entity. 
GET /api/v2/controllist/{CGIAREntity}/project/{id}
Requires FULL_READ_REST_API_PERMISSION.

​
Path parameters

​
CGIAREntity
string
required
Acronym of the CGIAR program, platform, or center (e.g., CCAFS, HarvestPlus).
​
id
number
required
Numeric MARLO project ID.

​
Response

Returns a ProjectDTO object.
​
id
number
Internal MARLO project ID.
Example: 
curl --request GET \
  --url 'https://your-marlo-host/api/v2/controllist/CCAFS/project/8432' \
  --header 'Authorization: Bearer <your-token>'
Example response: 
{
  "id": 8432
}
Returns 404 if no project with the given ID exists within the specified CGIAR entity.
The ProjectPage controller provides a richer aggregated view of a project, including partners, milestones, deliverables, innovations, policies, outcomes, and activities. That endpoint follows the same base URL pattern and authentication requirements. For innovation records linked to a specific project, use the project field filter available in the Innovations list response — the project field returns the project ID, allowing you to correlate innovations with their parent project.

​
Common error codes

HTTP statusMeaning
200Success
404Project not found for the given ID and CGIAR entity
401Missing or expired token
403Token valid but insufficient permissions or wrong program scope

Build docs developers (and LLMs) love

Get started for freeTalk to us