Assembly API

openapi: 3.1.0
info:
  title: Assembly API
  version: '2026-10-24'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-24: 2 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Assembly has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 1
    pages-with-code: 2
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-24'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://assembly.com/docs/api-reference/resources/invoices
  - https://assembly.com/docs/api-reference/rate-limits
  - https://assembly.com/docs/api-reference/introduction
servers:
- url: https://api.assembly.com
paths:
  /v1/invoices:
    get:
      operationId: get_v1_invoices
      tags:
      - Invoices
      summary: Listing invoices
      x-source: https://assembly.com/docs/api-reference/resources/invoices
      parameters:
      - name: clientId
        in: query
        required: false
        schema:
          type: string
        description: Filter invoices by client ID.
      - name: companyId
        in: query
        required: false
        schema:
          type: string
        description: Filter invoices by company ID.
      - name: subscriptionId
        in: query
        required: false
        schema:
          type: string
        description: Filter invoices by subscription ID.
      - name: includeCompanyInvoices
        in: query
        required: false
        schema:
          type: boolean
        description: When true with clientId, also return invoices billed to the company. Requires companyId.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1InvoicesResponse'
      x-evidence:
        kind: documentation
  /v1/me:
    get:
      operationId: get_v1_me
      tags:
      - Me
      summary: GET /v1/me
      x-source: https://assembly.com/docs/api-reference/rate-limits
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -i https://api.assembly.com/v1/me  -H \"X-API-KEY: <your-api-key>\" \n HTTP / 1.1 200 OK \n X-Assembly-Quota-Limit : 2000\
          \ \n X-Assembly-Quota-Remaining : 1847 \n X-Assembly-Quota-Reset : 1719792000 \n X-RateLimit-Limit : 20 \n X-RateLimit-Remaining : 19\
          \ \n On a daily-quota 429 , X-Assembly-Quota-Remaining is 0 . On a burst-limit 429 , X-RateLimit-Remaining is 0 and Retry-After is included.\
          \ \n ​ Best pr"
components:
  schemas:
    GetV1InvoicesResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for this item.
        createdAt:
          type: string
          description: The date this item was created in RFC3339 format.
        updatedAt:
          type: string
          description: The date this item was updated in RFC3339 format.
        object:
          type: string
          description: The object type of this resource.
        collectionMethod:
          type: string
          description: How the payment for this invoice is collected.
        currency:
          type: string
          description: The 3 letter currency code representing the settlement currency for this invoice.
        dueDate:
          type: string
          description: The date when this invoice is due in RFC3339 format.
        memo:
          type: string
          description: The memo added to the invoice.
        number:
          type: string
          description: A unique number generated for this invoice.
        recipientId:
          type: string
          description: Deprecated in favor of clientId and companyId.
        clientId:
          type: string
          description: The ID of the client this invoice is assigned to.
        companyId:
          type: string
          description: The ID of the company this invoice is assigned to.
        address:
          type: object
          description: Optional billing address associated with the invoice.
        sentDate:
          type: string
          description: The date this invoice was sent to a client in RFC3339 format.
        paymentSuccessDate:
          type: string
          description: The date this invoice was paid in RFC3339 format.
        status:
          type: string
          description: The status of the invoice (draft, open, paid, void).
        taxPercentage:
          type: number
          description: The percentage of tax set on this invoice.
        taxAmount:
          type: number
          description: The amount of tax on this invoice.
        total:
          type: number
          description: The total amount of this invoice to be paid.
        lineItems:
          type: array
          description: Array of line item objects.
        paymentMethodPreferences:
          type: array
          description: Array of payment method configuration objects.
        fileUrl:
          type: string
          description: Link to download invoice PDF.
        receiptNumber:
          type: string
          description: Invoice receipt number if invoice is paid.
        receiptUrl:
          type: string
          description: Link to download invoice receipt PDF, if invoice is paid.
        billingReason:
          type: string
          description: Indicates the reason why the invoice was created.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
security:
- apiKey: []
tags:
- name: Invoices
- name: Me