Skip to main content

List Projects

GET/v2/project/{project_key}/projects

Return every project (website / app) under the same Mida account as the supplied project key. The project key in the URL is used purely as auth context — you'll receive the full list of sibling projects, including the one matched by that key. Lets an external client (e.g. an AI agent) discover and switch between projects.

Auth model​

Every Mida project (widget) has its own API key, but they all live under one company. Possession of a valid API key for any project authorizes you to list, get, create, update, or delete any project in the same company — mirroring the dashboard, where switching projects in the sidebar is a freely-available action for account members.

Query parameters​

ParameterTypeDefaultDescription
limitinteger100Max projects to return. Maximum 500.
offsetinteger0Number of records to skip (for pagination).
include_inactivebooleanfalseWhen true, also include paused (status=0) projects. Soft-deleted projects (status=2) are never returned.

Example​

curl "https://api-{region}.mida.so/v2/project/YOUR_PROJECT_KEY/projects?limit=50" \
-H "Authorization: Bearer YOUR_GENERATED_API_KEY"

Success response​

{
"success": true,
"company_id": 1001,
"count": 2,
"projects": [
{
"project_key": "PROJECT_KEY_AAAAAAAAAA",
"name": "www.example.com",
"website_name": "www.example.com",
"widget_name": "www.example.com",
"allowed_website": "www.example.com",
"monthly_average_traffic": 50000,
"shopify_id": null,
"status": 1,
"company_id": 1001,
"created_at": "2025-12-04T10:05:52.000Z",
"updated_at": "2026-04-21T08:30:00.000Z"
},
{
"project_key": "PROJECT_KEY_BBBBBBBBBB",
"name": "store.example.com",
"website_name": "store.example.com",
"widget_name": "store.example.com",
"allowed_website": "store.example.com",
"monthly_average_traffic": 0,
"shopify_id": "1234567890",
"status": 1,
"company_id": 1001,
"created_at": "2026-03-18T11:20:00.000Z",
"updated_at": "2026-04-12T09:00:00.000Z"
}
]
}

Response fields​

FieldTypeDescription
company_idintegerThe Mida account that owns these projects
countintegerNumber of projects in this response page
projectsarrayList of project objects
projects[].project_keystring22-char public identifier — also the key= value in the Mida script tag
projects[].namestringDisplay name (defaults to website_name when set)
projects[].allowed_websitestringDomain(s) the script may run on (* = any)
projects[].statusinteger1 = active, 0 = paused

Pagination​

# Page 2 with 50 per page
curl "https://api-{region}.mida.so/v2/project/YOUR_PROJECT_KEY/projects?limit=50&offset=50" \
-H "Authorization: Bearer YOUR_GENERATED_API_KEY"

Error responses​

StatusMeaning
401Invalid or missing API key
403Project supplied as auth context is inactive
Next step

Pick a project_key from the response and pass it to Get Project Details, Update Project, or any of the experiment / event / goal endpoints.