Merge

Merge Subpackage Scopes API

The subpackage_scopes API from Merge — 16 operation(s) for subpackage_scopes.

Documentation GitHub OpenAPI

Operations 24

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 /accounting/v1/default-scopes Get default accounting data scopes · Default Scopes Retrieve #

Ask an LLM

“What Common Model and field permissions apply by default to every accounting Linked Account?”

“Which accounting fields does Merge sync by default before any per-account override?”

Tell an agent

Show the default accounting data scopes for my organization.

Get the organization-wide permission defaults for ledger integrations.

GET /accounting/v1/linked-account-scopes Get scopes for one accounting linked account · Linked Account Scopes Retrieve #

Ask an LLM

“Which accounting models and fields is one specific Linked Account allowed to sync?”

“Can I see the effective permissions for a single connected ledger?”

Tell an agent

Show the accounting scopes for linked account {account_token}.

Check which bookkeeping fields linked account {account_token} may read.

POST /accounting/v1/linked-account-scopes Override scopes for one accounting linked account · Linked Account Scopes Create #

Ask an LLM

“Can I restrict which accounting fields one Linked Account syncs without touching the defaults?”

“What happens to accounting scopes I leave out when overriding a single ledger connection?”

Tell an agent

Override the accounting scopes of linked account {account_token} with {common_models}.

Apply ledger model permissions {common_models} to connection {account_token}.

GET /ats/v1/default-scopes Get default recruiting (ATS) data scopes · Default Scopes Retrieve #

Ask an LLM

“What candidate and job data do all my ATS Linked Accounts sync by default?”

“Which recruiting Common Models are enabled organization-wide out of the box?”

Tell an agent

Show the default ATS permissions across all recruiting integrations.

List the baseline recruiting model scopes my organization uses.

GET /ats/v1/linked-account-scopes Get scopes for one ATS linked account · Linked Account Scopes Retrieve #

Ask an LLM

“Which candidate and application fields can one connected ATS actually sync?”

“Is a particular recruiting Linked Account allowed to read EEOC data?”

Tell an agent

Show the ATS scopes granted to linked account {account_token}.

Check which recruiting models connection {account_token} is permitted to pull.

POST /ats/v1/linked-account-scopes Override scopes for one ATS linked account · Linked Account Scopes Create #

Ask an LLM

“Can I stop one customer's ATS connection from syncing certain candidate fields?”

“Do recruiting scopes I don't set on an account fall back to the defaults?”

Tell an agent

Set ATS model permissions {common_models} on linked account {account_token}.

Limit recruiting data for connection {account_token} to {common_models}.

GET /default-scopes Get default scopes via the root path · Default Scopes Retrieve #

Ask an LLM

“Is there a default-scopes endpoint at the root path without a category prefix?”

“What does the unprefixed /default-scopes call return for my organization?”

Tell an agent

Call the root-level default-scopes endpoint with no category in the path.

Fetch organization default permissions from the unprefixed /default-scopes route.

GET /linked-account-scopes Get linked account scopes via the root path · Linked Account Scopes Retrieve #

Ask an LLM

“Can I read a Linked Account's scopes from the unprefixed root path?”

“What does the root-level /linked-account-scopes route show for one account?”

Tell an agent

Fetch scopes for account {account_token} from the root /linked-account-scopes route.

Use the category-less path to read permissions of {account_token}.

POST /linked-account-scopes Override linked account scopes via the root path · Linked Account Scopes Create #

Ask an LLM

“Can I post scope overrides to the root path instead of a category-specific one?”

“Does the unprefixed /linked-account-scopes POST also inherit defaults for unset models?”

Tell an agent

Post scope overrides {common_models} for {account_token} to the root /linked-account-scopes route.

Use the category-less path to update permissions of {account_token} to {common_models}.

GET /crm/v1/default-scopes Get default CRM data scopes · Default Scopes Retrieve #

Ask an LLM

“Which contact, deal and lead fields do CRM integrations sync by default?”

“What are my organization's baseline CRM permissions?”

Tell an agent

Show the default CRM scopes for all sales integrations.

Get the organization-level CRM Common Model permission defaults.

GET /crm/v1/linked-account-scopes Get scopes for one CRM linked account · Linked Account Scopes Retrieve #

Ask an LLM

“Which CRM objects is one customer's connected CRM allowed to sync?”

“Can I check whether a single CRM Linked Account has custom scopes?”

Tell an agent

Show the CRM scopes for linked account {account_token}.

Check which sales data connection {account_token} may read.

POST /crm/v1/linked-account-scopes Override scopes for one CRM linked account · Linked Account Scopes Create #

Ask an LLM

“Can I block a single CRM connection from syncing leads or notes?”

“Will CRM models I don't mention in the override keep their default permissions?”

Tell an agent

Override CRM scopes on linked account {account_token} with {common_models}.

Restrict sales data synced by {account_token} to {common_models}.

GET /filestorage/v1/default-scopes Get default file storage data scopes · Default Scopes Retrieve #

Ask an LLM

“Which file, folder and drive fields do file storage integrations sync by default?”

“What default permissions govern every connected document store?”

Tell an agent

Show the default file storage scopes for my organization.

Get the baseline drive and folder permissions for all storage integrations.

GET /filestorage/v1/linked-account-scopes Get scopes for one file storage linked account · Linked Account Scopes Retrieve #

Ask an LLM

“Which files and folders fields can one connected drive sync?”

“Can I see the permissions applied to a single file storage Linked Account?”

Tell an agent

Show the file storage scopes for linked account {account_token}.

Check which document fields drive connection {account_token} may read.

POST /filestorage/v1/linked-account-scopes Override scopes for one file storage linked account · Linked Account Scopes Create #

Ask an LLM

“Can I stop one customer's drive connection from syncing file permissions data?”

“Do storage models left out of an override inherit the defaults?”

Tell an agent

Set file storage permissions {common_models} for linked account {account_token}.

Narrow what drive connection {account_token} syncs to {common_models}.

GET /hris/v1/default-scopes Get default HRIS data scopes · Default Scopes Retrieve #

Ask an LLM

“Which employee and payroll fields do HRIS integrations sync by default?”

“What are the organization-wide HR data permissions?”

Tell an agent

Show the default HRIS scopes across all HR integrations.

Get the baseline employee data permissions for my organization.

GET /hris/v1/linked-account-scopes Get scopes for one HRIS linked account · Linked Account Scopes Retrieve #

Ask an LLM

“Is one customer's HRIS connection allowed to sync compensation or SSN fields?”

“Which HR models can a single Linked Account read?”

Tell an agent

Show the HRIS scopes for linked account {account_token}.

Check which employee fields HR connection {account_token} may sync.

POST /hris/v1/linked-account-scopes Override scopes for one HRIS linked account · Linked Account Scopes Create #

Ask an LLM

“Can I turn off sensitive employee fields for just one HRIS connection?”

“Do HR models I skip in an account override keep the default scopes?”

Tell an agent

Override HRIS scopes on linked account {account_token} with {common_models}.

Limit employee data synced by HR connection {account_token} to {common_models}.

GET /knowledgebase/v1/default-scopes Get default knowledge base data scopes · Default Scopes Retrieve #

Ask an LLM

“Which article and container fields do knowledge base integrations sync by default?”

“What default permissions apply to every connected help center or wiki?”

Tell an agent

Show the default knowledge base scopes for my organization.

Get baseline article permissions for all wiki integrations.

GET /knowledgebase/v1/linked-account-scopes Get scopes for one knowledge base linked account · Linked Account Scopes Retrieve #

Ask an LLM

“Which articles fields can one connected knowledge base sync?”

“Can I view the permissions set on a single wiki Linked Account?”

Tell an agent

Show the knowledge base scopes for linked account {account_token}.

Check which article data wiki connection {account_token} may read.

POST /knowledgebase/v1/linked-account-scopes Override scopes for one knowledge base linked account · Linked Account Scopes Create #

Ask an LLM

“Can I stop one knowledge base connection from syncing attachments?”

“Do wiki models I leave out of the override fall back to defaults?”

Tell an agent

Set knowledge base permissions {common_models} on linked account {account_token}.

Restrict article data synced by wiki connection {account_token} to {common_models}.

GET /ticketing/v1/default-scopes Get default ticketing data scopes · Default Scopes Retrieve #

Ask an LLM

“Which ticket, comment and user fields do ticketing integrations sync by default?”

“How do I find the baseline helpdesk permissions for my organization?”

Tell an agent

Show the default ticketing scopes across all helpdesk integrations.

Get the organization-wide ticket model permissions.

GET /ticketing/v1/linked-account-scopes Get scopes for one ticketing linked account · Linked Account Scopes Retrieve #

Ask an LLM

“Which ticket fields can one customer's helpdesk connection sync?”

“How do I check the permissions on a single ticketing Linked Account?”

Tell an agent

Show the ticketing scopes for linked account {account_token}.

Check which ticket data helpdesk connection {account_token} may read.

POST /ticketing/v1/linked-account-scopes Override scopes for one ticketing linked account · Linked Account Scopes Create #

Ask an LLM

“Can I prevent one helpdesk connection from syncing ticket comments?”

“Do ticketing models I omit from an override keep their default scopes?”

Tell an agent

Override ticketing scopes on linked account {account_token} with {common_models}.

Limit ticket data synced by helpdesk connection {account_token} to {common_models}.

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-scopes-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: Merge Subpackage Scopes API
  version: 1.0.0
  description: 'Operations tagged subpackage_scopes across 8 of this provider''s published API definitions: merge-accounting-api-openapi.yaml, merge-ats-api-openapi.yaml, merge-chat-api-openapi.yaml, merge-crm-api-openapi.yaml, merge-file-storage-api-openapi.yaml, merge-hris-api-openapi.yaml, merge-knowledge-base-api-openapi.yaml, merge-ticketing-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.merge.dev/api
- url: https://api-eu.merge.dev/api
- url: https://api-ap.merge.dev/api
- url: https://api.merge.dev/api/chat/v1
- url: https://api-eu.merge.dev/api/chat/v1
- url: https://api-ap.merge.dev/api/chat/v1
- url: https://api-ap.merge.dev/api/knowledgebase/v1
tags:
- name: subpackage_scopes
paths:
  /accounting/v1/default-scopes:
    get:
      operationId: default-scopes-retrieve
      summary: Default Scopes Retrieve
      description: Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - 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/CommonModelScopeAPI'
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /accounting/v1/linked-account-scopes:
    get:
      operationId: linked-account-scopes-retrieve
      summary: Linked Account Scopes Retrieve
      description: Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
    post:
      operationId: linked-account-scopes-create
      summary: Linked Account Scopes Create
      description: Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest'
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /ats/v1/default-scopes:
    get:
      operationId: getAtsV1DefaultScopes
      summary: Default Scopes Retrieve
      description: Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - 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/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: default-scopes-retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /ats/v1/linked-account-scopes:
    get:
      operationId: getAtsV1LinkedAccountScopes
      summary: Linked Account Scopes Retrieve
      description: Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-retrieve
    post:
      operationId: postAtsV1LinkedAccountScopes
      summary: Linked Account Scopes Create
      description: Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /default-scopes:
    get:
      operationId: getDefaultScopes
      summary: Default Scopes Retrieve
      description: Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - 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/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: default-scopes-retrieve
    servers:
    - url: https://api.merge.dev/api/chat/v1
    - url: https://api-eu.merge.dev/api/chat/v1
    - url: https://api-ap.merge.dev/api/chat/v1
  /linked-account-scopes:
    get:
      operationId: getLinkedAccountScopes
      summary: Linked Account Scopes Retrieve
      description: Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-retrieve
    post:
      operationId: postLinkedAccountScopes
      summary: Linked Account Scopes Create
      description: Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-create
    servers:
    - url: https://api.merge.dev/api/chat/v1
    - url: https://api-eu.merge.dev/api/chat/v1
    - url: https://api-ap.merge.dev/api/chat/v1
  /crm/v1/default-scopes:
    get:
      operationId: getCrmV1DefaultScopes
      summary: Default Scopes Retrieve
      description: Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - 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/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: default-scopes-retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /crm/v1/linked-account-scopes:
    get:
      operationId: getCrmV1LinkedAccountScopes
      summary: Linked Account Scopes Retrieve
      description: Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-retrieve
    post:
      operationId: postCrmV1LinkedAccountScopes
      summary: Linked Account Scopes Create
      description: Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /filestorage/v1/default-scopes:
    get:
      operationId: getFilestorageV1DefaultScopes
      summary: Default Scopes Retrieve
      description: Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - 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/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: default-scopes-retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /filestorage/v1/linked-account-scopes:
    get:
      operationId: getFilestorageV1LinkedAccountScopes
      summary: Linked Account Scopes Retrieve
      description: Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-retrieve
    post:
      operationId: postFilestorageV1LinkedAccountScopes
      summary: Linked Account Scopes Create
      description: Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /hris/v1/default-scopes:
    get:
      operationId: getHrisV1DefaultScopes
      summary: Default Scopes Retrieve
      description: Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - 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/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: default-scopes-retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /hris/v1/linked-account-scopes:
    get:
      operationId: getHrisV1LinkedAccountScopes
      summary: Linked Account Scopes Retrieve
      description: Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-retrieve
    post:
      operationId: postHrisV1LinkedAccountScopes
      summary: Linked Account Scopes Create
      description: Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /knowledgebase/v1/default-scopes:
    get:
      operationId: getKnowledgebaseV1DefaultScopes
      summary: Default Scopes Retrieve
      description: Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - 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/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: default-scopes-retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
    - url: https://api-ap.merge.dev/api/knowledgebase/v1
  /knowledgebase/v1/linked-account-scopes:
    get:
      operationId: getKnowledgebaseV1LinkedAccountScopes
      summary: Linked Account Scopes Retrieve
      description: Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-retrieve
    post:
      operationId: postKnowledgebaseV1LinkedAccountScopes
      summary: Linked Account Scopes Create
      description: Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
    - url: https://api-ap.merge.dev/api/knowledgebase/v1
  /ticketing/v1/default-scopes:
    get:
      operationId: getTicketingV1DefaultScopes
      summary: Default Scopes Retrieve
      description: Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - 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/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: default-scopes-retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /ticketing/v1/linked-account-scopes:
    get:
      operationId: getTicketingV1LinkedAccountScopes
      summary: Linked Account Scopes Retrieve
      description: Get all available permissions for Merge Common Models and fields for a single Linked Account. Learn more.
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-retrieve
    post:
      operationId: postTicketingV1LinkedAccountScopes
      summary: Linked Account Scopes Create
      description: Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more
      tags:
      - subpackage_scopes
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonModelScopeAPI'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest'
      x-operation-id-source: normalized
      x-operation-id-original: linked-account-scopes-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
components:
  schemas:
    LinkedAccountCommonModelScopeDeserializerRequest:
      type: object
      properties:
        common_models:
          type: array
          items:
            $ref: '#/components/schemas/IndividualCommonModelScopeDeserializerRequest'
          description: The common models you want to update the scopes for
      required:
      - common_models
      title: LinkedAccountCommonModelScopeDeserializerRequest
    ModelPermissionDeserializerRequest:
      type: object
      properties:
        is_enabled:
          type: boolean
      title: ModelPermissionDeserializerRequest
    IndividualCommonModelScopeDeserializer:
      type: object
      properties:
        model_name:
          type: string
        model_permissions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ModelPermissionDeserializer'
        field_permissions:
          $ref: '#/components/schemas/FieldPermissionDeserializer'
      required:
      - model_name
      title: IndividualCommonModelScopeDeserializer
    FieldPermissionDeserializerRequest:
      type: object
      properties:
        enabled_fields:
          type: array
          items:
            description: Any type
        disabled_fields:
          type: array
          items:
            description: Any type
      title: FieldPermissionDeserializerRequest
    ModelPermissionDeserializer:
      type: object
      properties:
        is_enabled:
          type: boolean
      title: ModelPermissionDeserializer
    CommonModelScopeAPI:
      type: object
      properties:
        common_models:
          type: array
          items:
            $ref: '#/components/schemas/IndividualCommonModelScopeDeserializer'
          description: The common models you want to update the scopes for
      required:
      - common_models
      title: CommonModelScopeAPI
    FieldPermissionDeserializer:
      type: object
      properties:
        enabled_fields:
          type: array
          items:
            description: Any type
        disabled_fields:
          type: array
          items:
            description: Any type
      title: FieldPermissionDeserializer
    IndividualCommonModelScopeDeserializerRequest:
      type: object
      properties:
        model_name:
          type: string
        model_permissions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ModelPermissionDeserializerRequest'
        field_permissions:
          $ref: '#/components/schemas/FieldPermissionDeserializerRequest'
      required:
      - model_name
      title: IndividualCommonModelScopeDeserializerRequest
  securitySchemes:
    tokenAuth:
      type: http
      scheme: bearer
      description: Token-based authentication with required prefix "Bearer"
x-refined-from:
- merge-accounting-api-openapi.yaml
- merge-ats-api-openapi.yaml
- merge-chat-api-openapi.yaml
- merge-crm-api-openapi.yaml
- merge-file-storage-api-openapi.yaml
- merge-hris-api-openapi.yaml
- merge-knowledge-base-api-openapi.yaml
- merge-ticketing-api-openapi.yaml

Merge Subpackage Scopes API

Operations 24

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