Comment on page

Project

Get Project
How to obtain all project data.
Request
Response
GET https://mburger.cloud/api/project
curl https://mburger.cloud/api/project?locale=it&include=sections&sort=-title
-H "Accept: application/json" 
-H "X-MBurger-Token: <token>" 
-H "X-MBurger-Version: 3"
 Parameters
Name
Type
Required
Description
include
string
No
Specify which relations to load and include in response.
image_format
string
No
Specify which image dimension to include in response. Values are thumb, medium, large and original. Default is medium.
 Includes
Name
Description
blocks
This relation will return all blocks of the project. You can also send blocks.sections, blocks.structure or blocks.sections.elements to obtain all the data in a single API call.
beacons
This relation will load all beacons associated with the project
contracts
This relation will return all contracts uploaded to the project
When successful, a HTTP 200 and JSON like this is returned:
{
  "status_code": 0,
  "body": {
    "id": 1,
    "name": "Awesome Project",
    "has_analytics": false,
    "has_beacons": true,
    "has_users": true,
    "has_multilanguage": true,
    "has_live_messages": true,
    "has_push": true,
    "has_subscriptions": false,
    "has_payments": true,
    "tz": "Europe\/Rome",
    "locales": {
      "it": "Italian",
      "en": "English"
    },
    "created_at": 1542981950,
    "updated_at": 1544016407
  }
}
​
​

API Authentication

Blocks

Last modified 3yr ago

Name	Type	Required	Description
include	string	No	Specify which relations to load and include in response.
image_format	string	No	Specify which image dimension to include in response. Values are thumb, medium, large and original. Default is medium.