Validere user_groups API

Manage User Groups

Operations 8

POST /app/v1/user_groups Create a user group #
POST /app/v1/user_groups/search Search user groups #
GET /app/v1/user_groups/{user_group_id} Get a user group #
PUT /app/v1/user_groups/{user_group_id} Update a user group #
DELETE /app/v1/user_groups/{user_group_id} Delete a user group #
GET /app/v1/user_groups/{user_group_id}/members Show Memberships for a user group #
PUT /app/v1/user_groups/{user_group_id}/members/{member_id} Add a user to a user group #
DELETE /app/v1/user_groups/{user_group_id}/members/{member_id} Remove a user from a user group #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/validere-user-groups-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

validere-user-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Activity Log
  title: CarbonHub activities User Groups API
  version: 1.0.0
servers:
- url: https://api.validere.io
security:
- Staging: []
- Integration: []
- Local: []
tags:
- description: Manage User Groups
  name: user_groups
paths:
  /app/v1/user_groups:
    post:
      operationId: create_user_group
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAndUpdateUserGroupInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
          description: A successful operation
      summary: Create a user group
      tags:
      - user_groups
  /app/v1/user_groups/search:
    post:
      operationId: search_user_groups
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
              - $ref: '#/components/schemas/Paginated'
              - $ref: '#/components/schemas/UserGroupSort'
              - $ref: '#/components/schemas/UserGroupFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedUserGroupList'
          description: successful operation
      summary: Search user groups
      tags:
      - user_groups
  /app/v1/user_groups/{user_group_id}:
    get:
      operationId: get_user_group
      parameters:
      - $ref: '#/components/parameters/UserGroupId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
          description: A successful operation
      summary: Get a user group
      tags:
      - user_groups
    put:
      operationId: update_user_group
      parameters:
      - $ref: '#/components/parameters/UserGroupId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAndUpdateUserGroupInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
          description: A successful operation
      summary: Update a user group
      tags:
      - user_groups
    delete:
      operationId: delete_user_group
      parameters:
      - $ref: '#/components/parameters/UserGroupId'
      responses:
        '200':
          description: successful operation
      summary: Delete a user group
      tags:
      - user_groups
  /app/v1/user_groups/{user_group_id}/members:
    get:
      operationId: list_user_group_members
      parameters:
      - $ref: '#/components/parameters/UserGroupId'
      responses:
        '200':
          description: A successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroupMembershipWithUser'
      summary: Show Memberships for a user group
      tags:
      - user_groups
  /app/v1/user_groups/{user_group_id}/members/{member_id}:
    put:
      operationId: add_user_group_member
      parameters:
      - $ref: '#/components/parameters/UserGroupId'
      - $ref: '#/components/parameters/MemberId'
      responses:
        '200':
          description: A successful operation
      summary: Add a user to a user group
      tags:
      - user_groups
    delete:
      operationId: remove_user_group_member
      parameters:
      - $ref: '#/components/parameters/UserGroupId'
      - $ref: '#/components/parameters/MemberId'
      responses:
        '200':
          description: A successful operation
      summary: Remove a user from a user group
      tags:
      - user_groups
components:
  schemas:
    PagedUserGroupList:
      allOf:
      - $ref: '#/components/schemas/Pagination'
      - properties:
          data:
            type: array
            items:
              type: array
              $ref: '#/components/schemas/UserGroup'
        type: object
    CreateAndUpdateUserGroupInput:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        group_category_id:
          type: string
          format: uuid
    UserBasic:
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type: string
          format: email
    UserGroupFilter:
      properties:
        filter:
          description: A filter object for User Groups where it can filter based on any of these following fields. No fields are mandatory and the syntax is roughly the same as MongoDB querying.
          allOf:
          - $ref: '#/components/schemas/AuditFields'
          - properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              group_category_id:
                type: string
                format: uuid
              user.id:
                type: string
                format: uuid
                example:
                  $in:
                  - c3e9446d-4cc0-4e7b-bb43-43fff9361957
                  - c3e9446d-4cc0-4e7b-bb43-43fff9361957
          type: object
    UserGroupSort:
      properties:
        sort_by:
          enum:
          - id
          - name
          - group_category_id
          - created_at
          - updated_at
          - created_by
          - updated_by
          example: name
          type: string
        sort_direction:
          default: desc
          description: Sort direction
          enum:
          - asc
          - desc
          example: desc
          type: string
    UserGroupMembershipWithUser:
      allOf:
      - $ref: '#/components/schemas/UserGroupMembership'
      - properties:
          user:
            $ref: '#/components/schemas/UserBasic'
    AuditFields:
      properties:
        created_at:
          format: date-time
          type: string
        updated_at:
          format: date-time
          type: string
        created_by:
          format: uuid
          type: string
        updated_by:
          format: uuid
          type: string
      type: object
    Paginated:
      properties:
        page:
          default: 0
          description: Which page to return
          example: 0
          type: number
        page_size:
          default: 10
          description: How many items to list in a page
          example: 20
          type: number
    UserGroup:
      allOf:
      - $ref: '#/components/schemas/CreateAndUpdateUserGroupInput'
      - $ref: '#/components/schemas/AuditFields'
      - properties:
          id:
            type: string
            format: uuid
          company_id:
            type: string
            format: uuid
    UserGroupMembership:
      allOf:
      - $ref: '#/components/schemas/AuditFields'
      - properties:
          company_id:
            type: string
            format: uuid
          user_group_id:
            type: string
            format: uuid
          user_id:
            type: string
            format: uuid
    Pagination:
      properties:
        page_number:
          type: number
          example: 0
        page_size:
          type: number
          example: 10
        total_entries:
          type: number
          example: 58
        total_pages:
          type: number
          example: 6
      type: object
  parameters:
    UserGroupId:
      description: User Group ID
      in: path
      name: user_group_id
      required: true
      schema:
        format: uuid
        type: string
    MemberId:
      description: Member ID
      in: path
      name: member_id
      required: true
      schema:
        format: uuid
        type: string