Lightdash home pagelight logodark logo
  • Book a demo
  • Login
  • Start for free
  • Start for free
Projects
Projects
Docs
API
  • About Us
  • Community
  • Blog
  • API
    • Introduction
    My Account
    • Overview
    • GET
      GetAuthenticatedUser
    • POST
      RegisterUser
    • PUT
      CreateEmailOneTimePasscode
    • GET
      GetEmailVerificationStatus
    • GET
      ListMyAvailableOrganizations
    • POST
      JoinOrganization
    • DEL
      DeleteMe
    • GET
      createWarehouseCredentials
    • POST
      updateWarehouseCredentials
    • DEL
      deleteWarehouseCredentials
    • PATCH
      updateWarehouseCredentials
    • GET
      getLoginOptions
    • PATCH
      Rotate personal access token
    Organizations
    • Overview
    • GET
      GetMyOrganization
    • PUT
      CreateOrganization
    • PATCH
      UpdateMyOrganization
    • DEL
      DeleteMyOrganization
    • GET
      ListOrganizationProjects
    • GET
      ListOrganizationMembers
    • GET
      GetOrganizationMemberByUuid
    • DEL
      DeleteOrganizationMember
    • GET
      ListOrganizationEmailDomains
    • PATCH
      UpdateOrganizationEmailDomains
    • GET
      ListGroupsInOrganization
    • POST
      CreateGroupInOrganization
    Projects
    • Overview
    • GET
      GetExplores
    • PUT
      SetExplores
    • GET
      GetExplore
    • POST
      CompileQuery
    • POST
      DownloadCsvFromExplore
    • GET
      GetProject
    • GET
      ListChartsInProject
    • GET
      ListChartSummariesInProject `Deprecated`
    • GET
      ListSpacesInProject
    • GET
      GetProjectAccessList
    • POST
      CalculateTotalFromQuery
    • GET
      getUserWarehouseCredentialsPreference
    • PATCH
      updateUserWarehouseCredentialsPreference
    • GET
      getCustomMetrics
    • PATCH
      updateProjectMetadata
    • DEL
      deleteProjectSemanticLayerConnection
    • PATCH
      updateProjectSemanticLayerConnection
    • GET
      getDashboards
    • POST
      createDashboard
    • PATCH
      updateDashboards
    • POST
      createPreview
    • PATCH
      Patch apiv1projects schedulersettings
    • GET
      getTags
    • POST
      createTag
    • DEL
      deleteTag
    • PATCH
      updateTag
    • GET
      getChartsAsCode
    • GET
      getDashboardsAsCode
    • POST
      upsertChartAsCode
    • POST
      upsertDashboardAsCode
    • GET
      GetLatestValidationResults
    • POST
      ValidateProject
    • DEL
      DeleteValidationDismiss
    Spaces
    • GET
      CreateSpaceInProject
    • DEL
      DeleteSpace
    Roles & Permissions
    • PATCH
      UpdateOrganizationMember
    • POST
      CreateSpaceInProject
    • GET
      Get apiv1projects access
    • POST
      GetProjectAccessList
    • GET
      GetProjectMemberAccess
    • DEL
      RevokeProjectAccessForUser
    • PATCH
      GrantProjectAccessToUser
    • PATCH
      UpdateSpace
    • POST
      AddSpaceUserAccess
    • DEL
      RevokeSpaceAccessForUser
    • POST
      AddSpaceGroupAccess
    • DEL
      RevokeGroupSpaceAccess
    Catalog
    • GET
      getCatalog
    • GET
      getMetadata
    • GET
      getAnalytics
    • GET
      getAnalyticsField
    • GET
      getMetricsCatalog
    • GET
      getMetric
    • GET
      getMetricsWithTimeDimensions
    • GET
      getSegmentDimensions
    • POST
      addCategoryToCatalogItem
    • DEL
      removeCategoryFromCatalogItem
    • PATCH
      updateCatalogItemIcon
    • GET
      getMetricsTree
    • POST
      createMetricsTreeEdge
    • DEL
      deleteMetricsTreeEdge
    Comments
    • POST
      createComment
    • GET
      getComments
    • DEL
      deleteComment
    • PATCH
      resolveComment
    Exports
    • GET
      getCsvUrl
    Dashboards
    • POST
      promoteDashboard
    • GET
      promoteDashboardDiff
    • GET
      installGithubAppForOrganization
    • GET
      githubOauthCallback
    • DEL
      uninstallGithubAppForOrganization
    • GET
      getGithubListRepositories
    Git Integration
    • GET
      GetConfiguration
    • GET
      CreatePullRequestForChartFields
    • POST
      CreatePullRequestForCustomMetrics
    Integrations
    • GET
      getAccessToken
    • POST
      uploadGsheet
    • GET
      getSlackChannels
    • PUT
      UpdateCustomSettings
    User Groups
    • GET
      getGroup
    • DEL
      deleteGroup
    • PATCH
      updateGroup
    • PUT
      addUserToGroup
    • DEL
      removeUserFromGroup
    • GET
      getGroupMembers
    • POST
      addProjectAccessToGroup
    • DEL
      removeProjectAccessFromGroup
    • PATCH
      updateProjectAccessForGroup
    Metrics Explorer
    • POST
      runMetricExplorerQuery
    • POST
      runMetricTotal
    Notifications
    • GET
      getNotifications
    • PATCH
      updateNotification
    Content
    • GET
      getPinnedItems
    • PATCH
      updatePinnedItemsOrder
    Exploring
    • POST
      RunSqlQuery
    • POST
      postRunUnderlyingDataQuery
    • POST
      RunMetricQuery
    Charts
    • POST
      PostChartResults
    • POST
      PostDashboardTile
    • GET
      GetChartHistory
    • GET
      GetChartVersion
    • POST
      getChartVersionResults
    • POST
      postChartVersionRollback
    • POST
      CalculateTotalFromSavedChart
    • POST
      promoteChart
    • GET
      promoteChartDiff
    • POST
      DownloadCsvFromSavedChart
    Schedulers
    • GET
      getSchedulerLogs
    • GET
      getScheduler
    • DEL
      deleteScheduler
    • PATCH
      updateScheduler
    • PATCH
      updateSchedulerEnabled
    • GET
      getScheduledJobs
    • GET
      getSchedulerJobStatus
    • POST
      sendScheduler
    Share links
    • GET
      getShareUrl
    • POST
      CreateShareUrl
    SSH Keypairs
    • POST
      createSshKeyPair
    User attributes
    • GET
      getUserAttributes
    • POST
      createUserAttribute
    • PUT
      updateUserAttribute
    • DEL
      removeUserAttribute
    Projects

    Projects

    Projects belong to a single organization. These routes allow users to manage their projects, browse content, and execute queries. Users inside an organization might have access to a project from an organization-level role or they might be granted access to a project directly.

    Raise issue
    CreateGroupInOrganizationGetExplores
    githubslacklinkedinx
    Powered by Mintlify