Opal

Opal Users API

The Users API from Opal — 6 operation(s) for users.

GitHub OpenAPI

Operations 7

GET /users/v2/{user_id} Return a user by ID #
PATCH /users/v2/{user_id} Update the specified user #
GET /users/v2/me Return the authenticated user #
PATCH /users/v2/me/moments_setting Update the Moments Setting for the authenticated user #
GET /users/v2/users List all users in the requesting users Opal #
GET /users/v3/users [UNSTABLE] Get users available to the authenticated user #
GET /users/v3/users/{user_id} [UNSTABLE] Get a specific user's information #

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-users-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-users-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-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Opal Users API
  license:
    name: Opal API License
    url: https://www.workwithopal.com/api-license
  version: '1.0'
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: opal-v2-openapi.json, opal-v3-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://login.ouropal.com
tags:


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