Organizations
CreateGroupInOrganization
API
My Account
- Overview
- GETGetAuthenticatedUser
- POSTRegisterUser
- PUTCreateEmailOneTimePasscode
- GETGetEmailVerificationStatus
- GETListMyAvailableOrganizations
- POSTJoinOrganization
- DELDeleteMe
- GETcreateWarehouseCredentials
- POSTupdateWarehouseCredentials
- DELdeleteWarehouseCredentials
- PATCHupdateWarehouseCredentials
- GETgetLoginOptions
- PATCHRotate personal access token
Organizations
- Overview
- GETGetMyOrganization
- PUTCreateOrganization
- PATCHUpdateMyOrganization
- DELDeleteMyOrganization
- GETListOrganizationProjects
- GETListOrganizationMembers
- GETGetOrganizationMemberByUuid
- DELDeleteOrganizationMember
- GETListOrganizationEmailDomains
- PATCHUpdateOrganizationEmailDomains
- GETListGroupsInOrganization
- POSTCreateGroupInOrganization
Projects
- Overview
- GETGetExplores
- PUTSetExplores
- GETGetExplore
- POSTCompileQuery
- POSTDownloadCsvFromExplore
- GETGetProject
- GETListChartsInProject
- GETListChartSummariesInProject `Deprecated`
- GETListSpacesInProject
- GETGetProjectAccessList
- POSTCalculateTotalFromQuery
- GETgetUserWarehouseCredentialsPreference
- PATCHupdateUserWarehouseCredentialsPreference
- GETgetCustomMetrics
- PATCHupdateProjectMetadata
- DELdeleteProjectSemanticLayerConnection
- PATCHupdateProjectSemanticLayerConnection
- GETgetDashboards
- POSTcreateDashboard
- PATCHupdateDashboards
- POSTcreatePreview
- PATCHPatch apiv1projects schedulersettings
- GETgetTags
- POSTcreateTag
- DELdeleteTag
- PATCHupdateTag
- GETgetChartsAsCode
- GETgetDashboardsAsCode
- POSTupsertChartAsCode
- POSTupsertDashboardAsCode
- GETGetLatestValidationResults
- POSTValidateProject
- DELDeleteValidationDismiss
Roles & Permissions
- PATCHUpdateOrganizationMember
- POSTCreateSpaceInProject
- GETGet apiv1projects access
- POSTGetProjectAccessList
- GETGetProjectMemberAccess
- DELRevokeProjectAccessForUser
- PATCHGrantProjectAccessToUser
- PATCHUpdateSpace
- POSTAddSpaceUserAccess
- DELRevokeSpaceAccessForUser
- POSTAddSpaceGroupAccess
- DELRevokeGroupSpaceAccess
Catalog
- GETgetCatalog
- GETgetMetadata
- GETgetAnalytics
- GETgetAnalyticsField
- GETgetMetricsCatalog
- GETgetMetric
- GETgetMetricsWithTimeDimensions
- GETgetSegmentDimensions
- POSTaddCategoryToCatalogItem
- DELremoveCategoryFromCatalogItem
- PATCHupdateCatalogItemIcon
- GETgetMetricsTree
- POSTcreateMetricsTreeEdge
- DELdeleteMetricsTreeEdge
Exports
Git Integration
User Groups
Metrics Explorer
Notifications
Charts
Schedulers
Share links
SSH Keypairs
Organizations
CreateGroupInOrganization
Creates a new group in the current user’s organization
POST
/
api
/
v1
/
org
/
groups
{
"results": {
"organizationUuid": "<string>",
"updatedByUserUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByUserUuid": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"uuid": "<string>",
"memberUuids": [
"<string>"
],
"members": [
{
"lastName": "<string>",
"firstName": "<string>",
"email": "<string>",
"userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"status": "ok"
}
Body
application/json
the new group details
A friendly name for the group
Response
200
application/json
Ok
Details for a group including a list of the group's members.
The UUID of the organization that the group belongs to
The UUID of the user that last updated the group
The time that the group was last updated
The UUID of the user that created the group
The time that the group was created
A friendly name for the group
The group's UUID
A list of the group's members.
A summary for a Lightdash user within a group
Available options:
ok
{
"results": {
"organizationUuid": "<string>",
"updatedByUserUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByUserUuid": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"uuid": "<string>",
"memberUuids": [
"<string>"
],
"members": [
{
"lastName": "<string>",
"firstName": "<string>",
"email": "<string>",
"userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"status": "ok"
}