Skip to main content

Get Project Details

GET/v2/project/{project_key}

Return details for a single project. The API key must be valid for the supplied project key (or any sibling project under the same company).

Path parameters

ParameterTypeDescription
project_keystringThe 22-char project key

Example

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

Success response

{
"success": true,
"project": {
"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"
}
}

Response fields

FieldTypeDescription
project_keystringPublic identifier — same value in the Mida script key= parameter
namestringDisplay name
website_namestringStored website name
widget_namestringInternal alias (usually equal to website_name)
allowed_websitestringDomain(s) the script may run on
monthly_average_trafficintegerHint used for plan suggestions
shopify_idstring | nullSet when this project was created from a Shopify install
statusinteger1 = active, 0 = paused
company_idintegerOwning account
created_at / updated_atstringISO 8601 timestamps

Error responses

StatusMeaning
401Invalid or missing API key
403Project is inactive
404Project not found