How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lightdash

Lightdash User Groups API

The User Groups API from Lightdash — 4 operation(s) for user groups.

Documentation Provider Profile APIs.io OpenAPI GitHub

Lightdash User Groups API is one of 50 APIs that Lightdash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include User Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

This API exposes 9 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.

Requests are made against a single base URL, /.

9 operations 4 paths 16 schemas 3 DELETE2 GET2 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.3156.1
Base URL
https://app.lightdash.cloud
Authentication
API Key, API Key
Contact
Lightdash Support
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash User Groups API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as connect.sid (session_cookie). An API key is passed in the header as Authorization (api_key).

  • api_key — Value should be 'ApiKey '

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 3 DELETE, 2 GET, 2 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User Groups 9
GET
/api/v1/groups/{groupUuid}
Get group
getGroup 3 params → 200default
DELETE
/api/v1/groups/{groupUuid}
Delete group
deleteGroup 1 param → 200default
PATCH
/api/v1/groups/{groupUuid}
Update group
updateGroup 1 param body → 200default
PUT
/api/v1/groups/{groupUuid}/members/{userUuid}deprecated
Add user to group
addUserToGroup 2 params → 200default
DELETE
/api/v1/groups/{groupUuid}/members/{userUuid}deprecated
Remove user from group
removeUserFromGroup 2 params → 200default
GET
/api/v1/groups/{groupUuid}/membersdeprecated
Get group members
getGroupMembers 1 param → 200default
POST
/api/v1/groups/{groupUuid}/projects/{projectUuid}deprecated
Add project access to group
addProjectAccessToGroup 2 params body → 200default
PATCH
/api/v1/groups/{groupUuid}/projects/{projectUuid}deprecated
Update project access for group
updateProjectAccessForGroup 2 params body → 200default
DELETE
/api/v1/groups/{groupUuid}/projects/{projectUuid}deprecated
Remove project access from group
removeProjectAccessFromGroup 2 params → 200default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Group (7 properties), GroupMember (4 properties), ProjectGroupAccess (3 properties), ApiGroupResponse (2 properties). Each schema is shown below with its type and property counts.

ApiUpdateProjectGroupAccess
object
2 properties 2 required
ApiCreateProjectGroupAccess
object
2 properties 2 required
Pick_CreateProjectGroupAccess.role_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
Group
object
7 properties 7 required
AnyType
This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are onl…
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
ApiSuccessEmpty
object
2 properties 1 required
ProjectMemberRole
string
Pick_GroupMember.userUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
GroupMember
object
A summary for a Lightdash user within a group
4 properties 4 required
ApiGroupResponse
object
2 properties 2 required
ApiGroupMembersResponse
object
2 properties 2 required
GroupWithMembers
Details for a group including a list of the group's members.
UpdateGroupWithMembers
object
2 properties
ProjectGroupAccess
object
3 properties 3 required
UpdateDBProjectGroupAccess
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-user-groups-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash AiAgents API
AE Profile APIs.io
Lightdash Bulk action API
AE Profile APIs.io
Lightdash Catalog API
AE Profile APIs.io
Lightdash Changesets API
AE Profile APIs.io
Lightdash Charts API
AE Profile APIs.io
Lightdash Comments API
AE Profile APIs.io
Lightdash Content API
AE Profile APIs.io
Lightdash Custom Roles API
AE Profile APIs.io
Lightdash Dashboards API
AE Profile APIs.io
Lightdash Explorer API
AE Profile APIs.io
Lightdash Exploring API
AE Profile APIs.io
Lightdash Exports API
AE Profile APIs.io
#User Groups
← Back to L APIs
API Details
ID
lightdash:lightdash-user-groups-api
Base URL
https://app.lightdash.cloud
Docs
https://docs.lightdash.com/api-reference/v1/introduction
Provider
Lightdash
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lightdash-user-groups-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightdash-user-groups-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Lightdash User Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.