Merge Subpackage Account Token API

openapi: 3.2.0
info:
  title: Merge Subpackage Account Token API
  version: 1.0.0
  description: 'Operations tagged subpackage_accountToken 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_accountToken
paths:
  /accounting/v1/account-token/{public_token}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns the account token for the end user with the provided public token.
      tags:
      - subpackage_accountToken
      parameters:
      - name: public_token
        in: path
        required: true
        schema:
          type: string
      - 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/AccountToken'
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /accounting/v1/account-token/regenerate:
    post:
      operationId: regenerate-create
      summary: Regenerate Create
      description: Exchange Linked Account account tokens.
      tags:
      - subpackage_accountToken
      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/RegenerateAccountToken'
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /ats/v1/account-token/{public_token}:
    get:
      operationId: getAtsV1AccountTokenByPublicToken
      summary: Retrieve
      description: Returns the account token for the end user with the provided public token.
      tags:
      - subpackage_accountToken
      parameters:
      - name: public_token
        in: path
        required: true
        schema:
          type: string
      - 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/AccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /ats/v1/account-token/regenerate:
    post:
      operationId: postAtsV1AccountTokenRegenerate
      summary: Regenerate Create
      description: Exchange Linked Account account tokens.
      tags:
      - subpackage_accountToken
      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/RegenerateAccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: regenerate-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /account-token/{public_token}:
    get:
      operationId: getAccountTokenByPublicToken
      summary: Retrieve
      description: Returns the account token for the end user with the provided public token.
      tags:
      - subpackage_accountToken
      parameters:
      - name: public_token
        in: path
        required: true
        schema:
          type: string
      - 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/AccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: 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
  /account-token/regenerate:
    post:
      operationId: postAccountTokenRegenerate
      summary: Regenerate Create
      description: Exchange Linked Account account tokens.
      tags:
      - subpackage_accountToken
      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/RegenerateAccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: regenerate-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/account-token/{public_token}:
    get:
      operationId: getCrmV1AccountTokenByPublicToken
      summary: Retrieve
      description: Returns the account token for the end user with the provided public token.
      tags:
      - subpackage_accountToken
      parameters:
      - name: public_token
        in: path
        required: true
        schema:
          type: string
      - 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/AccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /crm/v1/account-token/regenerate:
    post:
      operationId: postCrmV1AccountTokenRegenerate
      summary: Regenerate Create
      description: Exchange Linked Account account tokens.
      tags:
      - subpackage_accountToken
      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/RegenerateAccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: regenerate-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /filestorage/v1/account-token/{public_token}:
    get:
      operationId: getFilestorageV1AccountTokenByPublicToken
      summary: Retrieve
      description: Returns the account token for the end user with the provided public token.
      tags:
      - subpackage_accountToken
      parameters:
      - name: public_token
        in: path
        required: true
        schema:
          type: string
      - 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/AccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /filestorage/v1/account-token/regenerate:
    post:
      operationId: postFilestorageV1AccountTokenRegenerate
      summary: Regenerate Create
      description: Exchange Linked Account account tokens.
      tags:
      - subpackage_accountToken
      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/RegenerateAccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: regenerate-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /hris/v1/account-token/{public_token}:
    get:
      operationId: getHrisV1AccountTokenByPublicToken
      summary: Retrieve
      description: Returns the account token for the end user with the provided public token.
      tags:
      - subpackage_accountToken
      parameters:
      - name: public_token
        in: path
        required: true
        schema:
          type: string
      - 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/AccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /hris/v1/account-token/regenerate:
    post:
      operationId: postHrisV1AccountTokenRegenerate
      summary: Regenerate Create
      description: Exchange Linked Account account tokens.
      tags:
      - subpackage_accountToken
      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/RegenerateAccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: regenerate-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /knowledgebase/v1/account-token/{public_token}:
    get:
      operationId: getKnowledgebaseV1AccountTokenByPublicToken
      summary: Retrieve
      description: Returns the account token for the end user with the provided public token.
      tags:
      - subpackage_accountToken
      parameters:
      - name: public_token
        in: path
        required: true
        schema:
          type: string
      - 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/AccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: 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/account-token/regenerate:
    post:
      operationId: postKnowledgebaseV1AccountTokenRegenerate
      summary: Regenerate Create
      description: Exchange Linked Account account tokens.
      tags:
      - subpackage_accountToken
      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/RegenerateAccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: regenerate-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/account-token/{public_token}:
    get:
      operationId: getTicketingV1AccountTokenByPublicToken
      summary: Retrieve
      description: Returns the account token for the end user with the provided public token.
      tags:
      - subpackage_accountToken
      parameters:
      - name: public_token
        in: path
        required: true
        schema:
          type: string
      - 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/AccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: retrieve
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
  /ticketing/v1/account-token/regenerate:
    post:
      operationId: postTicketingV1AccountTokenRegenerate
      summary: Regenerate Create
      description: Exchange Linked Account account tokens.
      tags:
      - subpackage_accountToken
      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/RegenerateAccountToken'
      x-operation-id-source: normalized
      x-operation-id-original: regenerate-create
    servers:
    - url: https://api.merge.dev/api
    - url: https://api-eu.merge.dev/api
    - url: https://api-ap.merge.dev/api
components:
  schemas:
    AccountIntegrationCategoryBetaStatus:
      type: object
      properties: {}
      description: Category or categories this integration is in beta status for.
      title: AccountIntegrationCategoryBetaStatus
    CategoriesEnum:
      type: string
      enum:
      - hris
      - ats
      - accounting
      - ticketing
      - crm
      - mktg
      - filestorage
      - knowledgebase
      title: CategoriesEnum
    AccountIntegration:
      type: object
      properties:
        name:
          type: string
          description: Company name.
        abbreviated_name:
          type:
          - string
          - 'null'
          description: 'Optional. This shortened name appears in places with limited space, usually in conjunction with the platform''s logo (e.g., Merge Link menu).<br><br>Example: <i>Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors)</i>'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/CategoriesEnum'
          description: Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris].
        image:
          type:
          - string
          - 'null'
          format: uri
          description: Company logo in rectangular shape.
        square_image:
          type:
          - string
          - 'null'
          format: uri
          description: Company logo in square shape.
        color:
          type: string
          description: The color of this integration used for buttons and text throughout the app and landing pages. <b>Choose a darker, saturated color.</b>
        slug:
          type: string
        api_endpoints_to_documentation_urls:
          type: object
          additionalProperties:
            description: Any type
          description: 'Mapping of API endpoints to documentation urls for support. Example: {''GET'': [[''/common-model-scopes'', ''https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve''],[''/common-model-actions'', ''https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve'']], ''POST'': []}'
        webhook_setup_guide_url:
          type:
          - string
          - 'null'
          description: Setup guide URL for third party webhook creation. Exposed in Merge Docs.
        category_beta_status:
          $ref: '#/components/schemas/AccountIntegrationCategoryBetaStatus'
          description: Category or categories this integration is in beta status for.
      required:
      - name
      title: AccountIntegration
    RegenerateAccountToken:
      type: object
      properties:
        linked_account_id:
          type: string
        account_token:
          type: string
      required:
      - linked_account_id
      - account_token
      description: '# The RegenerateAccountToken Object

        ### Description

        The `RegenerateAccountToken` object is used to exchange an old account token for a new one.


        ### Usage Example

        Post to receive a new `RegenerateAccountToken`.'
      title: RegenerateAccountToken
    AccountToken:
      type: object
      properties:
        account_token:
          type: string
        integration:
          $ref: '#/components/schemas/AccountIntegration'
        id:
          type: string
      required:
      - account_token
      - integration
      - id
      title: AccountToken
    CategoriesEnum_2:
      type: string
      enum:
      - hris
      - ats
      - accounting
      - ticketing
      - crm
      - mktg
      - filestorage
      - knowledgebase
      description: '* `hris` - hris

        * `ats` - ats

        * `accounting` - accounting

        * `ticketing` - ticketing

        * `crm` - crm

        * `mktg` - mktg

        * `filestorage` - filestorage

        * `knowledgebase` - knowledgebase'
      title: CategoriesEnum
  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