BurstIQ User Group APIs API
User Groups are ways of identifying groups of users by name and referencing in various parts of the platform
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/burstiq-user-group-apis-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: LifeGraph User Group APIs API
description: LifeGraph API descriptions
license:
name: BurstIQ, Inc.
url: https://www.burstiq.com
version: 2.42.0
servers:
- url: https://api.burstiq.com
description: Generated server url
tags:
- name: User Group APIs
description: User Groups are ways of identifying groups of users by name and referencing in various parts of the platform
paths:
/api/metadata/usergroup/{id}:
get:
tags:
- User Group APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
get the user group in the secure data zone'
operationId: getUserGroupById
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserGroup'
summary: Get user group by id
x-summary-source: derived
put:
tags:
- User Group APIs
description: 'Allowed user roles:
sdzAdmin
sdzGovernance
put (update) a User group into the secure data zone'
operationId: putUpdateUserGroup
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupReq'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserGroup'
summary: Put update user group
x-summary-source: derived
delete:
tags:
- User Group APIs
description: 'Allowed user roles:
sdzAdmin
sdzGovernance
delete the user group in the secure data zone'
operationId: deleteUserGroup
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
summary: Delete user group
x-summary-source: derived
/api/metadata/usergroup:
get:
tags:
- User Group APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
query user groups from the secure data zone'
operationId: getQueryUserGroups
parameters:
- name: name
in: query
required: false
schema:
type: string
- name: description
in: query
required: false
schema:
type: string
- name: groupContains
in: query
required: false
schema:
type: array
items:
type: string
format: uuid
- name: orderBy
in: query
required: false
schema:
type: array
items:
type: string
- name: limit
in: query
required: false
schema:
type: integer
format: int32
- name: skip
in: query
required: false
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/UserGroup'
summary: Get query user groups
x-summary-source: derived
post:
tags:
- User Group APIs
description: 'Allowed user roles:
sdzAdmin
sdzGovernance
create a User group into the secure data zone'
operationId: postCreateUserGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupReq'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserGroup'
summary: Post create user group
x-summary-source: derived
/api/metadata/usergroup/{id}/history:
get:
tags:
- User Group APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
gets the history of a userGroup'
operationId: getHistory
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/UserGroup'
summary: Get history
x-summary-source: derived
/api/metadata/usergroup/search:
get:
tags:
- User Group APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
search for terms'
operationId: getSearch
parameters:
- name: terms
in: query
required: true
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/UserGroup'
uniqueItems: true
summary: Get search
x-summary-source: derived
/api/metadata/usergroup/lookup:
get:
tags:
- User Group APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
get the user group in the secure data zone'
operationId: getUserGroupByName
parameters:
- name: name
in: query
required: true
schema:
type: string
minLength: 1
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserGroup'
summary: Get user group by name
x-summary-source: derived
components:
schemas:
UserGroupReq:
type: object
properties:
name:
type: string
description:
type: string
group:
type: array
items:
type: string
format: uuid
uniqueItems: true
UserGroup:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
minLength: 1
description:
type: string
group:
type: array
items:
type: string
format: uuid
uniqueItems: true
required:
- group
- id
- name