MBurger Headless CMS
User GuideCMS HeadlessEngagement Platform
  • ๐Ÿ”MBurger Documentation๐Ÿ”
  • ๐Ÿ”‘ API
    • Introduction
      • Getting Started
      • Structure
    • Common Path
      • Basics
      • POST Bodies
      • POST Relations
      • Evaluating Responses
    • API Authentication
    • Project
    • Blocks
      • Get Blocks
      • Get Block
    • Sections
      • Get Sections
      • Get Section
      • Create Section
      • Update Section
      • Delete Section
    • Media
      • Get All Media
      • Upload Media
      • Get Media
      • Delete Media
    • Integrations / Extensions
      • Authentication Provider
        • Registration
        • Login
        • Logout
        • Get Profile
        • Update Profile
        • Delete Profile
        • Change Password
        • Forgot Password
      • Live Messages
        • Get All Live Messages
        • Send Live Message
        • Delete Live Message
      • In-App Subscriptions
        • InApp Subscription
        • Resume InApp Subscription
      • Shopify
        • Create a Shopify private app
        • Enable Shopify in MBurger
        • Collections Editor
      • Stripe
        • Create Customer
        • Get Cards
        • Create Card
        • Make Default
        • Delete Card
        • Subscription
        • Cancel Subscription
        • Resume Subscription
        • Payment
    • Going Deeper
      • Available Data Types (Elements)
  • ๐Ÿ“ฑ Android SDK
    • Introduction
    • Installation
    • Initialization
    • Fetch for blocks
    • Fetch sections from blocks
    • Mapping to custom objects
    • Admin
      • Delete a Section/Media
      • Create a new Section
      • Update an existing Section
    • Auth
      • Register a new user
      • Authenticate a user
      • User profile
      • Edit profile
      • Other features
    • Proguard Rules
    • Plugins
    • Sample Apps
      • MBurger Explorer
      • MBurger Radio
    • MBurger Apps
  • ๐Ÿ iOS SDK
    • Introduction
    • Installation
    • Initialization
    • Fetch the project
    • Fetch blocks
    • Fetch sections
    • Media
    • Encoding & Decoding
    • Serialization & Equality
    • Admin
      • Add/Edit a section
      • Delete a section
      • Upload media
      • Delete a media
    • Auth
      • Register a user
      • Authenticate a user
      • Retrieve user information
      • Update user profile
    • Plugins
    • Sample Apps
      • MBurger Explorer
      • MBurger Radio
    • MBurger Apps
  • ๐Ÿ’ป PHP SDK
    • Installation & Configuration
    • How to use
    • Support & Feedback
    • License
  • โ˜• JavaScript SDK
    • Introduction
    • Installation
    • Configuration
    • Methods Reference
    • Support & Feedback
    • License
  • ๐Ÿ”ทFlutter SDK
    • Installation
    • Initialization
    • Fetch the project
    • Fetch blocks
    • Fetch sections
    • Media
    • Admin
      • Add/Edit a section
      • Delete a section
      • Upload a media
      • Delete a media
    • Auth
      • Register a user
      • Authenticate a user
      • Retrieve user information
      • Update user profile
  • โ“How to?
    • Basic interactions
      • Blocks
        • Get a Single Block
        • Get multiple Blocks
      • Sections
        • Get a single Section
        • Get Multiple Sections
        • Create a Section
        • Update a Section
        • Delete a Section
    • Advanced section retrieval
      • Filter sections
      • Obtain distance from a section
      • Manage locales and the fallback language
      • Get a section by SLUG
      • Obtain only sections with a defined relation
    • Advanced section creation
      • Create a section with a relation
      • Set the value of a checkbox element
      • Create a section with a multiple or dropdown element
      • Create a section with a SLUG
      • Create a section with SEO
      • Send or schedule a push when creating a section
    • Set the visibility of a section
    • Get images with various format
  • ๐Ÿ‘ป Sample App
    • Introduction
    • Create an MBurger project
    • Create Home, News and Gallery blocks
    • Create the project
    • Setup the SDK
    • Query the API for items
    • Map your objects from MBurger objects
    • Implement push notifications
    • Take a bite
Powered by GitBook
On this page

Was this helpful?

  1. API

Project

Get Project

How to obtain all project data.

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
  }
}

PreviousAPI AuthenticationNextBlocks

Last updated 4 years ago

Was this helpful?

๐Ÿ”‘