Qonto · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qonto Business Organizations & Accounts API

7 actions 7 updates phrasing extends openapi/qonto-organizations-accounts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Qonto's API. It is a proposal applied on top of the contract, not a document Qonto publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v2/organization'].get
$.paths['/v2/memberships'].get
$.paths['/v2/memberships'].post
$.paths['/v2/labels'].get
$.paths['/v2/teams'].get
$.paths['/v2/teams'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Qonto Business Organizations & Accounts API
  version: 1.0.0
extends: openapi/qonto-organizations-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v2/organization'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization and its bank accounts
      effect: read
      questions:
      - Which bank accounts does my organization have and what are their balances?
      - Can I see my company's IBANs and account details in one call?
      - What organization am I authenticated as in Qonto?
      instructions:
      - text: Show me our organization details and all its bank accounts.
      - text: Get the IBANs and balances of our business accounts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of the organization
      effect: read
      questions:
      - Who has access to my company's business account?
      - Can I page through all the users who are members of the organization?
      - Which employees are members of our account and what roles do they have?
      instructions:
      - text: List everyone who is a member of our organization.
      - text: Show page {page} of organization members, {per_page} per page.
        slots:
          page: query.current_page
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a new member to the organization
      effect: write
      questions:
      - Who can I add as a new member of our business account, and how?
      - Can I invite a teammate to join the organization through the API?
      instructions:
      - text: Invite a new employee to join our organization.
      - text: Add a new member to our business account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction labels
      effect: read
      questions:
      - What labels has my company set up to categorize transactions?
      - Can I get the list of bookkeeping labels we use?
      instructions:
      - text: List all the labels we use to tag transactions.
      - text: Show me our organization's categorization labels.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams in the organization
      effect: read
      questions:
      - Which teams exist in my company's account?
      - Can I see how our members are grouped into teams?
      instructions:
      - text: List all the teams in our organization.
      - text: Show me the teams set up on our business account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new team
      effect: write
      questions:
      - Is it possible to set up a new team to group employees?
      - Can I add a department as a team in the organization?
      instructions:
      - text: Create a new team in our organization.
      - text: Set up a team for a new department.
      method: generated
      generated: '2026-10-01'