LuckPanda Parties API

openapi: 3.2.0
info:
  title: Luckpanda App Parties API
  version: 1.0.0
  description: 'Operations tagged Parties across 2 of this provider''s published API definitions: openapi.yaml, luckpanda-app-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://luckpanda.app/api/v1
- url: http://127.0.0.1:8787/api/v1
  description: Local `wrangler dev`
security:
- bearerAuth: []
tags:
- name: Parties
paths:
  /parties:
    get:
      tags:
      - Parties
      operationId: listParties
      x-mcp-tool: party_list
      parameters:
      - $ref: '#/components/parameters/PartyRole'
      - $ref: '#/components/parameters/Cursor'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/PartyQuery'
      - $ref: '#/components/parameters/PartyExternalRef'
      - $ref: '#/components/parameters/PartyEmail'
      summary: Rows include the profile (D91).
      responses:
        '200':
          $ref: '#/components/responses/Page'
    post:
      tags:
      - Parties
      operationId: createParty
      x-mcp-tool: party_create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePartyCommand'
      responses:
        '201':
          $ref: '#/components/responses/CommandAccepted'
        '422':
          $ref: '#/components/responses/Problem'
      summary: Create party
      x-summary-source: derived
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
  /parties/{partyId}:
    get:
      tags:
      - Parties
      operationId: getParty
      x-mcp-tool: party_get
      parameters:
      - $ref: '#/components/parameters/PartyId'
      responses:
        '200':
          $ref: '#/components/responses/Resource'
        '404':
          $ref: '#/components/responses/Problem'
      summary: Get party
      x-summary-source: derived
    patch:
      tags:
      - Parties
      operationId: updateParty
      x-mcp-tool: party_update
      summary: Changes name, kind, external_ref or profile fields (D91).
      parameters:
      - $ref: '#/components/parameters/PartyId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePartyCommand'
      responses:
        '200':
          $ref: '#/components/responses/CommandAccepted'
        '409':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
  /parties/by-ref/{externalRef}:
    put:
      tags:
      - Parties
      operationId: upsertPartyByRef
      x-mcp-tool: party_upsert
      summary: Creates the party with this external_ref (201) or updates the existing one with…
      parameters:
      - $ref: '#/components/parameters/ExternalRef'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertPartyCommand'
      responses:
        '200':
          $ref: '#/components/responses/CommandAccepted'
        '201':
          $ref: '#/components/responses/CommandAccepted'
        '409':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
  /engagements:
    post:
      tags:
      - Parties
      operationId: createEngagement
      x-mcp-tool: engagement_create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolInput'
      responses:
        '201':
          $ref: '#/components/responses/CommandAccepted'
      summary: Create engagement
      x-summary-source: derived
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
components:
  responses:
    Resource:
      description: Authorized resource
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
    Page:
      description: Cursor page
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Page'
    Problem:
      description: Typed RFC 7807 error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    CommandAccepted:
      description: 'Command result: succeeded, awaiting_approval (a proposal) or preview (dry_run)'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CommandResult'
  parameters:
    PartyEmail:
      name: email
      in: query
      description: Primary contact email
      case-insensitive.: null
      schema:
        type: string
        maxLength: 320
    ExternalRef:
      name: externalRef
      in: path
      required: true
      description: Your system's id for the customer (URL-encoded).
      schema:
        type: string
        minLength: 1
        maxLength: 200
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 50
        default: 25
    Cursor:
      name: cursor
      in: query
      schema:
        type: string
        maxLength: 500
    PartyRole:
      name: role
      in: query
      description: Omitted or client = customers, prospects and parties without a role (never pure vendors); all = every party.
      schema:
        type: string
        enum:
        - customer
        - vendor
        - lead
        - client
        - all
    PartyId:
      name: partyId
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Uuid'
    PartyQuery:
      name: q
      in: query
      description: Substring of the name or a contact email.
      schema:
        type: string
        maxLength: 200
    PartyExternalRef:
      name: external_ref
      in: query
      schema:
        type: string
        maxLength: 200
  schemas:
    UpsertPartyCommand:
      allOf:
      - $ref: '#/components/schemas/CommandBase'
      - type: object
        required:
        - display_name
        properties:
          display_name:
            type: string
            minLength: 1
            maxLength: 300
          kind:
            type: string
            enum:
            - organization
            - person
          roles:
            type: array
            minItems: 1
            uniqueItems: true
            items:
              type: string
              enum:
              - customer
              - vendor
              - lead
      - $ref: '#/components/schemas/PartyProfile'
    PartyProfile:
      description: Client profile (D91). Omitted keeps, null clears (on update). additionalProperties is checked on the merged command.
      type: object
      properties:
        contact_name:
          type:
          - string
          - 'null'
          maxLength: 200
        email:
          type:
          - string
          - 'null'
          maxLength: 320
        phone:
          type:
          - string
          - 'null'
          maxLength: 30
        billing_address:
          $ref: '#/components/schemas/AddressIn'
        shipping_address:
          $ref: '#/components/schemas/AddressIn'
        country_code:
          type:
          - string
          - 'null'
          pattern: ^[A-Z]{2}$
        state_code:
          type:
          - string
          - 'null'
          pattern: ^[0-9]{2}$
          description: India GST state code; defaults to the GSTIN prefix.
        tax_id:
          type:
          - string
          - 'null'
          maxLength: 100
          description: GSTIN (validated) for India; VAT or other tax number elsewhere. Unique per business.
        currency:
          type:
          - string
          - 'null'
          pattern: ^[A-Z]{3}$
        payment_terms_days:
          type:
          - integer
          - 'null'
          minimum: 0
          maximum: 365
        notes:
          type:
          - string
          - 'null'
          maxLength: 4000
    CommandResult:
      type: object
      required:
      - operation_id
      - status
      - correlation_id
      properties:
        operation_id:
          $ref: '#/components/schemas/Uuid'
        status:
          type: string
          enum:
          - succeeded
          - awaiting_approval
          - preview
        correlation_id:
          $ref: '#/components/schemas/Uuid'
        resource:
          type: object
          additionalProperties: true
        approval_request_id:
          $ref: '#/components/schemas/Uuid'
    VersionedCommand:
      allOf:
      - $ref: '#/components/schemas/CommandBase'
      - type: object
        required:
        - expected_version
        properties:
          expected_version:
            type: integer
            minimum: 1
    Uuid:
      type: string
      format: uuid
    CreatePartyCommand:
      allOf:
      - $ref: '#/components/schemas/CommandBase'
      - type: object
        required:
        - kind
        - display_name
        - roles
        properties:
          kind:
            type: string
            enum:
            - organization
            - person
          display_name:
            type: string
            minLength: 1
            maxLength: 300
          roles:
            type: array
            minItems: 1
            uniqueItems: true
            items:
              type: string
              enum:
              - customer
              - vendor
              - lead
          external_ref:
            type: string
            maxLength: 200
      - $ref: '#/components/schemas/PartyProfile'
    Problem:
      type: object
      required:
      - type
      - title
      - status
      - code
      properties:
        type:
          type: string
          format: uri-reference
        title:
          type: string
        status:
          type: integer
        code:
          type: string
          description: 'VALIDATION_FAILED (422) the body or a field is wrong; see field_errors.

            FORBIDDEN (401 no or revoked key, 403 missing permission or grant).

            NOT_FOUND (404).

            APPROVAL_REQUIRED (403) an agent (or any key over /mcp) tried to issue, send or pay; send proposal_only to propose instead.

            INTEGRATION_LIMIT (403) a server-integration key is outside its kinds, legal entities or largest total.

            PAYWALL (402) the business has not unlocked the outcome (issuing needs the Sales module); the body names the module.

            INVALID_STATE (409) the document is not in a state that allows this (e.g. issuing a cancelled document).

            STALE_VERSION (409) expected_version is behind; reload and retry.

            IDEMPOTENCY_MISMATCH (409) the idempotency_key was used with a different body.

            DUPLICATE_EXTERNAL_REF (409) a document of this kind already has this external_ref.

            COMPLIANCE_BLOCKED (409) a compliance rule blocks the change (e.g. cancelling a document with an active e-invoice IRN).

            ALLOCATION_EXCEEDS_AVAILABLE (409) a payment allocation is more than the receipt or the amount due allows.

            NOT_IMPLEMENTED (501) a path or option that is planned but not served.

            DELIVERY_FAILED (502, /invoices send step) the email provider refused the message.

            RATE_LIMITED (429).

            '
          enum:
          - VALIDATION_FAILED
          - FORBIDDEN
          - NOT_FOUND
          - APPROVAL_REQUIRED
          - INTEGRATION_LIMIT
          - PAYWALL
          - INVALID_STATE
          - STALE_VERSION
          - IDEMPOTENCY_MISMATCH
          - DUPLICATE_EXTERNAL_REF
          - COMPLIANCE_BLOCKED
          - ALLOCATION_EXCEEDS_AVAILABLE
          - CONFLICT
          - NOT_IMPLEMENTED
          - DELIVERY_FAILED
          - RATE_LIMITED
          - INTERNAL_ERROR
        message:
          type: string
        field_errors:
          type: array
          items:
            type: object
            required:
            - path
            - code
            properties:
              path:
                type: string
              code:
                type: string
        correlation_id:
          $ref: '#/components/schemas/Uuid'
    AddressIn:
      anyOf:
      - type: string
        maxLength: 1000
      - type: object
        required:
        - line1
        properties:
          line1:
            type: string
            minLength: 1
            maxLength: 300
          line2:
            type:
            - string
            - 'null'
          city:
            type:
            - string
            - 'null'
          state_code:
            type:
            - string
            - 'null'
            pattern: ^[0-9]{2}$
          postal_code:
            type:
            - string
            - 'null'
          country_code:
            type:
            - string
            - 'null'
            pattern: ^[A-Z]{2}$
        additionalProperties: false
      - type: 'null'
    Page:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          maxItems: 100
          items:
            type: object
            additionalProperties: true
        next_cursor:
          type:
          - string
          - 'null'
    IdempotencyKey:
      type: string
      minLength: 16
      maxLength: 128
      pattern: ^[A-Za-z0-9._:-]+$
    UpdatePartyCommand:
      allOf:
      - $ref: '#/components/schemas/VersionedCommand'
      - type: object
        properties:
          display_name:
            type: string
            minLength: 1
            maxLength: 300
          kind:
            type: string
            enum:
            - organization
            - person
          roles:
            type: array
            minItems: 1
            uniqueItems: true
            items:
              type: string
              enum:
              - customer
              - vendor
              - lead
          external_ref:
            type:
            - string
            - 'null'
            maxLength: 200
      - $ref: '#/components/schemas/PartyProfile'
    ToolInput:
      type: object
      description: The input schema of the operation's `x-mcp-tool` (minus the ids the path supplies). See `architecture/mcp-tools.json`.
      required:
      - idempotency_key
      - correlation_id
      additionalProperties: true
    CommandBase:
      type: object
      required:
      - idempotency_key
      - correlation_id
      properties:
        idempotency_key:
          $ref: '#/components/schemas/IdempotencyKey'
        correlation_id:
          $ref: '#/components/schemas/Uuid'
        dry_run:
          type: boolean
          default: false
        proposal_only:
          type: boolean
          default: false
          description: Make it a proposal for a person to accept instead of acting.
        approval_request_id:
          $ref: '#/components/schemas/Uuid'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque API key, lpk_...
      description: Made in Workspace > Developers (agent or server-integration). Not a JWT.
x-refined-from:
- openapi.yaml
- luckpanda-app-openapi.yaml