Noloco
Ask the CommunityHire an ExpertLoginSign up
  • Noloco Overview
  • 🚀Quickstart
    • Start with your data
    • Start with AI
    • Start with a template
  • Data to App
    • Database Consolidation
  • App Settings
  • Components
    • Containers
    • Video
  • Templates
  • 🔗Data Sources
    • Data Overview
      • Setting a Collection's Primary Field
      • Syncing
    • Noloco Tables
      • Field Types
      • Relationships
      • Automatic Links
      • Rollup Fields
      • Lookup Fields
      • Formulas
      • Noloco AI
      • Import a file
    • Airtable
    • Google Sheets
    • SmartSuite
    • MySQL
    • PostgreSQL
    • REST APIs
    • HubSpot
    • Stripe
    • Xano
  • 📄Pages
    • Collection views
      • Show collection record count
      • Empty State
    • Blank pages
    • iFrame embeds
    • External links
    • The Home Page
    • User Profile Page
    • Parent pages & folders
    • Page visibility rules
    • Cloning pages
    • Renaming pages
    • Hiding pages
    • Sidebar dividers
    • Tabs
  • 📂Collections
    • Adding collection views
    • Display
      • Rows
      • Cards & columns
      • Tables
      • Kanban boards
      • Calendar
      • Timeline
      • Gantt
      • Split-view
      • Charts
      • Maps
      • Pivot Table
      • Single record view
      • Grouping records
      • Record Colors
    • Filters
      • Logged in user
      • Relative Filters
      • Record values
    • Filter fields
    • Sort & limit
    • Row Action
    • Column Summaries
  • 📝Forms
    • Forms
      • Customizing Form Fields
      • Passing Linked Record Values to a Form
      • Dynamic Form Field Filters
      • E-Signature Fields
    • Public Forms
  • 📃Record Pages
    • Overview
    • Visibility Settings
    • Hidden Field Values
    • Record Comments
  • ✏️Field Formatting
    • Field visibility conditions
    • In-line editing
    • Conditional Highlight Colors
    • Dates & Time Zones
  • 📊Charts
    • Overview
  • 📂Data Management
    • Export Data
    • Import Data
  • 👥Users & Permissions
    • User Table
    • User Management
    • User Roles & Permissions
      • Record-level permissions
      • Field-level permissions
    • Open Sign Up
    • Offboarding Users
    • Testing as other users
  • ⏩Actions
    • Action buttons
      • Create records
      • Update records
      • Bulk actions
      • Barcode Scanner
      • Add a Comment Action
  • ⚡Workflows
    • Workflows
      • On-demand workflows
      • Comment Added Trigger
      • Watched Fields
      • Trigger webhooks
      • Send automated emails
      • For each item in a list...do...
      • Only continue if
      • Create a Record Action
      • Update a Record Action
      • Delete a Record Action
      • Deactivate a User Action
      • Reactivate a User Action
      • Send an Invitation Email Action
      • Add a comment to a record
      • Send a Push Notification
      • Ask Chat GPT Action
      • Summarize Text Action
      • Correct Grammar Action
      • Extract Keywords Action
      • Analyze Sentiment
      • Finish Text Action
      • Send a message to a Slack Channel
      • Send a message to a Slack User
      • Generate a PDF with DocsAutomator
  • 🔔Notifications
    • Notifications
    • Notification Preferences
  • 📑API Documentation
    • API Overview
      • Fetching Records
      • Fetching a Record
      • Creating a Record
      • Update a Record
      • Deleting a record
  • ⚙️Settings
    • General Settings
      • Live Mode
      • Custom Logos
    • Theme & Design
    • Progressive web apps
    • Navigation Settings
    • Spaces
    • Email Settings
    • Custom Code
    • Custom Domain
    • Login & Signup
      • Sign in Options
      • Single Sign On
      • 2FA - Two Factor Authentication
      • Client Portal User Add-On
    • Public Access
    • Login Screen
    • User Lists
    • Integrations & API Keys
    • Billing & Usage
    • Support
    • Publishing
      • App Version History
  • 🔄Integrations
    • Zapier
    • Make (Integromat)
    • Sign in With Google
    • Intercom
    • SMTP Emails
    • Documint
  • ⚙️Account
    • Workspaces
    • Pricing
      • Client Portal Add-on (Legacy)
    • Transferring an App
    • Onboarding Call Preparation
Powered by GitBook
On this page
  • Introduction
  • Authentication
  • GraphQL Overview
  • What is GraphQL
  • GraphiQL Explorer
  1. API Documentation

API Overview

Use your app's GraphQL API to fetch, update, create and delete data in your Noloco app.

Introduction

Welcome to the Noloco API Documentation. This guide will provide you with all the essential information to seamlessly integrate and make the most of Noloco's dynamic GraphQL API. Each Noloco application comes equipped with a dedicated GraphQL API, offering CRUD access to the tables in your application. Here's a step-by-step breakdown of our API.

Authentication

To ensure the security and privacy of your data, our API mandates authentication for all requests.

How to Authenticate:

  1. Bearer Authentication Token: The API uses Bearer auth tokens for authentication. Include this token in the authorization header of your request.

  2. Obtaining Your API Key: Navigate to the API & Integrations settings in your Noloco app to retrieve your API key.

Sample header:

Authorization: Bearer YOUR_API_KEY

Remember, keep your API key confidential to ensure your app's data remains secure.

GraphQL Overview

Noloco's dynamic GraphQL API offers an efficient, powerful, and flexible approach to manage the data in your app. GraphQL allows you to request precisely what you need and nothing more, ensuring your applications are fast and stable.

Endpoint:

For each Noloco app, your GraphQL endpoint will be:

https://api.portals.noloco.io/data/<app_name>

Replace <app_name> with the name of your Noloco application.

What is GraphQL

GraphQL is a query language for APIs and a server-side runtime for executing those queries by using a type system that you define for your data. It was developed by Facebook in 2012 and released as an open-source project in 2015. Unlike traditional REST APIs, GraphQL gives clients the power to specify exactly what data they need, which can lead to more efficient and precise queries.

Key Features and Benefits of GraphQL:

  1. Flexibility in Queries: Clients can retrieve all the information they need in a single request. This avoids over-fetching or under-fetching of data, making applications more efficient and reducing the load on the server.

  2. Strongly Typed: Every GraphQL API is defined by its schema. This means the API's shape, the types of data it returns, and the operations it supports are all determined by the schema, which ensures data integrity and safety.

  3. Community and Ecosystem: Being open-source and popular means a plethora of tools, libraries, and resources are available for GraphQL across different programming languages.

Learn More About GraphQL:

By integrating GraphQL into Noloco, we ensure that you have the most flexible, efficient, and powerful tool to manage and retrieve your data as your needs evolve.

GraphiQL Explorer

Want to experiment with your queries or familiarize yourself with the capabilities of our GraphQL API? The GraphiQL Explorer is a playground for you.

Accessing GraphiQL Explorer:

  1. Navigate to the API & Integrations settings in your Noloco app.

  2. Look for the GraphiQL API Explorer option and open it.

The Explorer offers an intuitive interface, auto-complete features, and built-in documentation to help you frame your queries efficiently.

The explorer makes it easy to browse the different queries and mutations your app offers, and makes it easy to build and test the queries you need.

By opening the explorer from your app the API key will pre-populate so you can start making requests immediately.

PreviousNotification PreferencesNextFetching Records

Last updated 1 year ago

Self-Documenting: GraphQL APIs are self-descriptive. Tools like the can auto-generate comprehensive documentation, making the API more developer-friendly.

: The best place to get started. It provides in-depth documentation, best practices, and community resources.

: A free and open-source tutorial to learn all around GraphQL to go from zero to production.

: A rich source of articles, best practices, and discussions around GraphQL development.

📑
Official GraphQL Website
How to GraphQL
Apollo GraphQL Blog
GraphiQL Explorer