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
    • 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
    • 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
  • Querying a Specific Record
  • Specifying the Unique Identifier
  • Selecting Fields to Return
  • Conclusion
  1. API Documentation
  2. API Overview

Fetching a Record

Fetch a single record from the API

Fetching specific records is an essential operation, especially when you want details about a particular item or user. With Noloco's dynamic GraphQL API, you can retrieve specific records efficiently using the table's name. This guide will walk you through the process and the structure required to fetch a particular record.

Querying a Specific Record

To fetch a specific record, use the table name in your query. The query is structured as: query <tableName>, where <tableName> represents the table containing the record you wish to retrieve.

For instance:

  • To fetch details about a specific user, the query starts as query user.

Specifying the Unique Identifier

To fetch a specific record, you need to provide a unique identifier. This ensures that the record returned matches your exact criteria. You can use:

  • id: The unique identifier for the record.

  • uuid: A universally unique identifier.

  • Custom unique fields: Tables may have other unique fields specified, such as email on the User table. You can use these as arguments to pinpoint the record.

Example:

query {
  user(email: "example@email.com") {
    id
    firstName
    lastName
    email
  }
}

Selecting Fields to Return

Once you've identified which record you want, you can specify the fields you wish to return. You're not limited to only the fields on the table. If there are relationships set up, such as the lead of a project, you can also retrieve related fields.

Example:

query {
query {
  projects(id: 17) {
    name
    description
    lead {
      id
      firstName
      lastName
      email
    }
  }
}

In the example above, not only are we fetching details about a specific project, but we're also retrieving information about its lead, a related user field.

Conclusion

Noloco's dynamic GraphQL API offers a structured and precise method for fetching specific records. By understanding the query structure, unique identifiers, and how to specify return fields, you can easily retrieve detailed information about any record in your system. This ability enhances data retrieval efficiency and ensures you always have the right data at your fingertips.

PreviousFetching RecordsNextCreating a Record

Last updated 1 year ago

📑