Merge

Merge Subpackage Registered Users API

The subpackage_registeredUsers API from Merge — 2 operation(s) for subpackage_registeredusers.

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/registered-users/ List registered users · List Registered Users #

Ask an LLM

“Which registered users exist in my organization?”

“Can I find a registered user by their origin user ID?”

Tell an agent

List registered users with origin user ID {origin_user_id}.

Show all my registered users.

POST /api/v1/registered-users/ Register a user · Create Registered User #

Ask an LLM

“How do I register one of my app's users?”

“Can I register a system user instead of a human?”

Tell an agent

Register user {origin_user_name} with origin ID {origin_user_id} and id {id}.

Create a {user_type} registered user {origin_user_name} (origin {origin_user_id}, id {id}).

GET /api/v1/registered-users/{registered_user_id}/ Get a registered user · Get Registered User #

Ask an LLM

“How do I look up one registered user?”

“What user type and credential group does a registered user have?”

Tell an agent

Get registered user {registered_user_id}.

Show details for registered user {registered_user_id}.

DELETE /api/v1/registered-users/{registered_user_id}/ Delete a registered user · Delete Registered User #

Ask an LLM

“What removes a registered user from my organization?”

“Can I permanently delete a registered user record?”

Tell an agent destructive · confirm first

Delete registered user {registered_user_id}.

Remove registered user {registered_user_id} for good.

PATCH /api/v1/registered-users/{registered_user_id}/ Update a registered user · Update Registered User #

Ask an LLM

“How do I rename a registered user?”

“Can I move a registered user to a different shared credential group?”

Tell an agent

Rename registered user {registered_user_id} to {origin_user_name}.

Put registered user {registered_user_id} in credential group {shared_credential_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/merge:merge-subpackage-registeredusers-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

openapi: 3.2.0
info:
  title: Agent Handler Subpackage Registered Users API
  version: 1.0.0
servers:
- url: https://ah-api.merge.dev
tags:
- name: subpackage_registeredUsers
paths:
  /api/v1/registered-users/:
    get:
      operationId: list
      summary: List Registered Users
      description: Retrieves a list of Registered Users
      tags:
      - subpackage_registeredUsers
      parameters:
      - name: origin_user_id
        in: query
        description: Filter by the origin user ID of the Registered User
        required: false
        schema:
          type: string
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRegisteredUserPublicResponseList'
    post:
      operationId: create
      summary: Create Registered User
      description: Creates a Registered User with the given values
      tags:
      - subpackage_registeredUsers
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredUserPublicResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisteredUserPublicRequest'
  /api/v1/registered-users/{registered_user_id}/:
    get:
      operationId: retrieve
      summary: Get Registered User
      description: Retrieves a Registered User by ID
      tags:
      - subpackage_registeredUsers
      parameters:
      - name: registered_user_id
        in: path
        description: Agent Handler ID of the Registered User
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredUserPublicResponse'
    delete:
      operationId: destroy
      summary: Delete Registered User
      description: Deletes a Registered User by ID
      tags:
      - subpackage_registeredUsers
      parameters:
      - name: registered_user_id
        in: path
        description: Agent Handler ID of the Registered User
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
    patch:
      operationId: partial-update
      summary: Update Registered User
      description: Updates fields on a Registered User by ID
      tags:
      - subpackage_registeredUsers
      parameters:
      - name: registered_user_id
        in: path
        description: Agent Handler ID of the Registered User
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredUserPublicResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRegisteredUserPublicRequest'
components:
  schemas:
    RegisteredUserPublicRequestUserType:
      type: string
      enum:
      - HUMAN
      - SYSTEM
      default: HUMAN
      description: 'ENUM of `HUMAN` or `SYSTEM`


        * `HUMAN` - HUMAN

        * `SYSTEM` - SYSTEM'
      title: RegisteredUserPublicRequestUserType
    SharedCredentialGroup:
      type: object
      properties:
        origin_company_id:
          type:
          - string
          - 'null'
          description: Unique identifier for the company of the Registered User
        origin_company_name:
          type:
          - string
          - 'null'
          description: The human readable name of the company of the Registered User
        custom_groupings:
          type: object
          additionalProperties:
            type: string
          description: Optional identifier / grouping that you can provide to further segment Registered Users
      title: SharedCredentialGroup
    PatchedRegisteredUserPublicRequestUserType:
      type: string
      enum:
      - HUMAN
      - SYSTEM
      default: HUMAN
      description: 'ENUM of `HUMAN` or `SYSTEM`


        * `HUMAN` - HUMAN

        * `SYSTEM` - SYSTEM'
      title: PatchedRegisteredUserPublicRequestUserType
    PaginatedRegisteredUserPublicResponseList:
      type: object
      properties:
        count:
          type: integer
        next:
          type:
          - string
          - 'null'
          format: uri
        previous:
          type:
          - string
          - 'null'
          format: uri
        results:
          type: array
          items:
            $ref: '#/components/schemas/RegisteredUserPublicResponse'
      required:
      - count
      - results
      title: PaginatedRegisteredUserPublicResponseList
    RegisteredUserPublicRequest:
      type: object
      properties:
        id:
          type: string
        origin_user_id:
          type: string
          description: Unique identifier for Registered User
        origin_user_name:
          type: string
          description: The human readable name of Registered User
        shared_credential_group:
          $ref: '#/components/schemas/SharedCredentialGroup'
          description: Object used to identify which the groupings a Registered User is part of and can share credentials across.
        user_type:
          oneOf:
          - $ref: '#/components/schemas/RegisteredUserPublicRequestUserType'
          - type: 'null'
          description: 'ENUM of `HUMAN` or `SYSTEM`


            * `HUMAN` - HUMAN

            * `SYSTEM` - SYSTEM'
      required:
      - id
      - origin_user_id
      - origin_user_name
      title: RegisteredUserPublicRequest
    PatchedRegisteredUserPublicRequest:
      type: object
      properties:
        id:
          type: string
        origin_user_id:
          type: string
          description: Unique identifier for Registered User
        origin_user_name:
          type: string
          description: The human readable name of Registered User
        shared_credential_group:
          $ref: '#/components/schemas/SharedCredentialGroup'
          description: Object used to identify which the groupings a Registered User is part of and can share credentials across.
        user_type:
          oneOf:
          - $ref: '#/components/schemas/PatchedRegisteredUserPublicRequestUserType'
          - type: 'null'
          description: 'ENUM of `HUMAN` or `SYSTEM`


            * `HUMAN` - HUMAN

            * `SYSTEM` - SYSTEM'
      title: PatchedRegisteredUserPublicRequest
    RegisteredUserPublicResponse:
      type: object
      properties:
        id:
          type: string
        origin_user_id:
          type: string
          description: Unique identifier for Registered User
        origin_user_name:
          type: string
          default: Yash
          description: The human readable name of Registered User
        shared_credential_group:
          oneOf:
          - $ref: '#/components/schemas/SharedCredentialGroup'
          - type: 'null'
          description: Object used to identify which the groupings a Registered User is part of and can share credentials across.
        user_type:
          type: string
          default: HUMAN
          description: ENUM of `HUMAN` or `SYSTEM`
        authenticated_connectors:
          type: array
          items:
            type: string
          description: List of connector slugs that the user has authenticated with
        is_test:
          type: boolean
          default: false
          description: Whether this is a test user or production user
      required:
      - id
      - origin_user_id
      - shared_credential_group
      - authenticated_connectors
      title: RegisteredUserPublicResponse
  securitySchemes:
    tokenAuth:
      type: http
      scheme: bearer
      description: Token-based authentication with required prefix "Bearer"

Merge Subpackage Registered Users API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification