📄 Summary: What You’ll Learn in This Article
This article explains what GraphQL is and how to connect to it.
-
Check if GraphQL is enabled in your system
-
Authenticate with OAuth2 and access tokens
-
Use Nitro or Banana Cake Pop (UI tools) for queries
🧑‍🤝‍🧑 Who Should Read This?
This article is most useful for:
-
Anyone new to GraphQL who wants to understand how to access and query data in Marmind using the GraphQL API.
✔️ Prerequisites: What Should You Know Before Getting Started?
Level: Advanced
Access required: Admin access to the environment and GraphQL credentials
-
Basic understanding of data structures is helpful
What GraphQL Can Do
The Marmind API is based on the GraphQL standard and provides comprehensive access to a wide range of business objects used in Marmind.
Think of GraphQL as a data menu. Instead of being forced to order a fixed meal (like with REST APIs), you can choose exactly what you want on your plate.
For example, if you only need the campaign name and ID, you don’t have to fetch all campaign details. GraphQL lets you ask for only the fields you want, which makes it faster and cleaner.
A basic query looks like this:
query {
folders(first: 10) {
nodes {
id
name
}
}
}
This will return the first 10 folders with only their IDs and names. That’s the power of GraphQL: you’re in control of the data depth and shape.
Step-by-Step Guide
1. Verify GraphQL Availability
-
GraphQL is available on most new Marmind systems where it has been enabled.
-
Open your browser and try the URL:
https://<your-instance>.marmind.com/graphql/api/ui/ -
Some systems may use
/graphql/api/. Try both if unsure. -
If enabled, you’ll see a sandbox interface called Nitro (formerly known as Banana Cake Pop).
-
Click on “Create Document”
2. Authenticate with OAuth2
To run queries, you must log in with OAuth2 Client Credentials.
-
On the top right, go to Connection Settings > Authorization.
-
Select OAuth2 and choose Client Credentials.
-
Enter:
-
Access Token URL:
https://<your-instance>.marmind.com/graphql/oauth2/token -
Client ID and Client Secret (found in your password manager tool or provided by admin).
-
Scopes: the syntax for the scopes are provided by admin
-
base scope every user needs
-
reading data
-
creating/updating data
-
budget and cost queries (this scope is only available for clients with the budget feature activated)
Tip: include all four to avoid missing data later.
-
-
-
Click Fetch Token. If successful, you’ll receive an access token.
-
Apply it, reload your page once, and the schema explorer should now be active.
-
The schema is now loaded and you have access to all GraphQL queries and mutations.
âť“ FAQs