Opal

Opal User Groups API

The User Groups API from Opal — 5 operation(s) for user groups.

GitHub OpenAPI

Operations 8

GET /user_groups/v3/user_groups Get User Groups available to the authenticated user #
POST /user_groups/v3/user_groups Create a new User Group #
GET /user_groups/v3/user_groups/{user_group_id} Get a User Group #
PATCH /user_groups/v3/user_groups/{user_group_id} Update an existing User Group #
DELETE /user_groups/v3/user_groups/{user_group_id} Delete a User Group #
DELETE /user_groups/v3/user_groups/all/relationships/members Delete all User Group Members for User #
POST /user_groups/v3/user_groups/do/get_intersections Filter a list of groups to those intersecting given lists of users and groups #
POST /user_groups/v3/user_groups/{user_group_id}/do/get_intersections Filter a list of groups to those intersecting a source group #

Documentation

📖
Documentation
https://login.ouropal.com/api/documentation/v2
📖
APIReference
https://login.ouropal.com/api/documentation/v2
📖
Documentation
https://login.ouropal.com/api/documentation/v3
📖
APIReference
https://login.ouropal.com/api/documentation/v3
📖
Documentation
https://login.ouropal.com/api/documentation/asgard_bff

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-user-groups-api-openapi.yml

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/opal-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.

GitHub Google LinkedIn

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

OpenAPI Specification

opal-user-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 3.0.0
  title: Opal API (⚠️ WIP) User Groups API
  license:
    name: Opal API License
    url: https://www.workwithopal.com/api-license
  description: The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
servers:
- url: https://login.ouropal.com
tags:


# --- truncated at 32 KB (198 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-user-groups-api-openapi.yml