Getting Started: Create Your First Project in mFoundry

Projects are the foundation of everything you build in mFoundry — they group your workflows, collaborators, and configuration into a single, manageable unit. This guide walks you through creating your first project, attaching a workflow to it, and bringing in a teammate, whether you prefer clicking through the dashboard or scripting with the REST API.

Dashboard
API

Open Projects and create a new one

From the mFoundry dashboard, navigate to the Projects section in the left sidebar. Click New Project in the top-right corner to open the project creation dialog.

Enter a name and description

Type a clear, recognizable name for your project and add an optional description that tells teammates what the project is for. Click Create Project to save it and land on the project overview page.

Add a workflow

Inside your new project, select the Workflows tab. Click Add Workflow, give it a name, and use the workflow builder to define your first steps. Save the workflow when you are ready — it will appear in the workflows list immediately.

Invite a collaborator

Navigate to the Members tab within the project. Click Invite Member, enter your teammate’s email address, and choose an appropriate role. Click Send Invite — they will receive an email with a link to join.

Before making API calls, make sure you have a valid API token. Include it as a Bearer token in every request header.Step 1 — Create a project

curl -X POST https://api.mfoundry.io/v1/projects \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My First Project",
    "description": "An introductory project to explore mFoundry."
  }'

Sample response:

{
  "id": "proj_01hx9k2m3n4p5q6r",
  "name": "My First Project",
  "description": "An introductory project to explore mFoundry.",
  "created_at": "2024-06-01T10:00:00Z",
  "status": "active"
}

Step 2 — Confirm your project is readyUse the id returned above to retrieve your project and verify it was created successfully:

curl -X GET https://api.mfoundry.io/v1/projects/proj_01hx9k2m3n4p5q6r \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Sample response:

{
  "id": "proj_01hx9k2m3n4p5q6r",
  "name": "My First Project",
  "description": "An introductory project to explore mFoundry.",
  "created_at": "2024-06-01T10:00:00Z",
  "status": "active"
}

Step 3 — Update the project name or descriptionUse PUT /projects/:id to rename the project or refine its description as your requirements evolve:

curl -X PUT https://api.mfoundry.io/v1/projects/proj_01hx9k2m3n4p5q6r \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Onboarding",
    "description": "Workflows for new customer onboarding and activation."
  }'

Sample response:

{
  "id": "proj_01hx9k2m3n4p5q6r",
  "name": "Customer Onboarding",
  "description": "Workflows for new customer onboarding and activation.",
  "created_at": "2024-06-01T10:00:00Z",
  "updated_at": "2024-06-01T10:15:00Z",
  "status": "active"
}

Once your project is set up, use the dashboard’s workflow builder to add and configure workflows, or continue exploring the API reference for additional endpoints.

Give your projects clear, purpose-driven names — for example, “Customer Onboarding”, “Data Pipeline — Production”, or “Marketing Automations” — so teammates can immediately understand what each project contains and who owns it.

Next Steps

Connect Integrations

Link mFoundry to Slack, GitHub, Jira, and other tools to automate your workflow and keep all your context in one place.

Manage Your Team

Invite teammates, assign roles, and control who can view or edit projects using mFoundry’s role-based access controls.

Get Started

Core Concepts

Guides

Configuration

Help

Getting Started: Create Your First Project in mFoundry

Next Steps

Connect Integrations

Manage Your Team

​Next Steps

Connect Integrations

Manage Your Team

Next Steps