> ## Documentation Index
> Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List



## OpenAPI

````yaml /openapi_v4_core.json get /v4/core/companies/{companyId}/syncs
openapi: 3.0.0
info:
  title: Commenda Integrations V4 API
  description: Commenda Integrations — unified accounting, commerce, and CRM API.
  version: 4.0.0
  contact: {}
servers:
  - url: https://api.integrations.commenda.io
    description: Production
security:
  - api_key: []
tags: []
paths:
  /v4/core/companies/{companyId}/syncs:
    get:
      tags:
        - Syncs
      summary: List
      operationId: SyncController_list
      parameters:
        - name: companyId
          required: true
          in: path
          schema:
            type: number
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: number
        - name: cursor
          required: false
          in: query
          schema:
            type: string
        - name: jobType
          required: false
          in: query
          schema:
            type: string
            enum:
              - PUSH
              - PULL
              - CUSTOM
      responses:
        '200':
          description: Paginated list of syncs for the company.
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ListSyncsResponse'
                  request_id:
                    type: string
                    format: uuid
                required:
                  - data
                  - request_id
      security:
        - api_key: []
components:
  schemas:
    ListSyncsResponse:
      type: object
      properties:
        syncs:
          type: array
          items:
            $ref: '#/components/schemas/SerializedSync'
        count:
          type: number
        next:
          type: string
          nullable: true
      required:
        - syncs
        - count
        - next
    SerializedSync:
      type: object
      properties:
        id:
          type: string
        companyId:
          type: number
          nullable: true
        integrationType:
          type: string
          enum:
            - BUSY
            - CLEARBOOKS
            - FREEAGENT
            - FRESHBOOKS
            - KASHFLOW
            - MEKARI_JURNAL
            - MS_DYNAMICS_365
            - MS_DYNAMICS_365_FO
            - MYOB_BUSINESS
            - NETSUITE
            - ODOO_ACCOUNTING
            - QOYOD
            - QUICKBOOKS
            - QUICKBOOKS_SANDBOX
            - ROOTFI_SANDBOX
            - SAGE_CLOUD_ACCOUNTING
            - SAGE_ZA_CLOUD_ACCOUNTING
            - SAGE_INTACCT
            - TALLY
            - WAFEQ
            - WAVE
            - XERO
            - ZOHO_BOOKS
            - PUZZLE_SANDBOX
            - PUZZLE
            - RILLET
            - RILLET_SANDBOX
            - AMAZON
            - BIG_COMMERCE
            - SHOPIFY
            - SQUARESPACE
            - WIX
            - WOO_COMMERCE
            - GOOGLE_PLAYSTORE
            - CHARGEBEE
            - MOLLIE
            - PAYPAL
            - PAYPAL_SANDBOX
            - RAZORPAY
            - SQUARE
            - SQUARE_SANDBOX
            - STRIPE
            - STRIPE_TEST
            - STRIPE_SANDBOX
            - ZOHO_INVOICE
            - PADDLE
            - PADDLE_SANDBOX
            - HUBSPOT
            - PIPEDRIVE
            - SALES_FORCE
            - ZOHO_CRM
            - GUSTO
        dataModels:
          type: array
          items:
            type: string
            enum:
              - ACCOUNT
              - BALANCE_SHEET
              - BANK_ACCOUNT
              - BANK_TRANSACTION
              - BILL
              - BILL_CREDIT_NOTE
              - BILL_PAYMENT
              - CASH_FLOW_STATEMENT
              - COMPANY_INFO
              - CONTACT
              - CURRENCY
              - DOCUMENT
              - EXPENSE
              - GOODS_RECEIPT_NOTE
              - INCOME_STATEMENT
              - INVOICE
              - INVOICE_CREDIT_NOTE
              - INVOICE_PAYMENT
              - ITEM
              - JOURNAL_ENTRY
              - JOURNAL_LINE
              - PROJECT
              - PURCHASE_ORDER
              - SALES_ORDER
              - ESTIMATE
              - TAX_RATE
              - TRACKING_CATEGORY
              - CASH_SALE
              - CASH_REFUND
              - BALANCE
              - DISPUTE
              - ORDER
              - PAYOUT
              - SUBSCRIPTION
              - TRANSACTION
              - EVENT
              - FULFILLMENT
              - INVENTORY
              - COMPANY
              - LEAD
              - OPPORTUNITY
              - PIPELINE
              - PIPELINE_STAGE
              - NOTE
              - TASK
              - OWNER
              - ENGAGEMENT
              - ADDRESS
              - EXTERNAL_LINK
              - LINE_ITEM
              - PHONE_NUMBER
              - VARIANT
        configMode:
          type: string
          enum:
            - CREATE
            - READ
            - UPDATE
            - DELETE
            - DOWNLOAD
            - CUSTOM
        fullSync:
          type: boolean
        syncType:
          type: string
          enum:
            - MANUAL
            - AUTO_SYNC
        status:
          type: string
          enum:
            - SUCCESS
            - RUNNING
            - FAILED
            - PARTIAL_SUCCESS
        jobCounts:
          $ref: '#/components/schemas/SyncJobCounts'
        dataModelCounts:
          $ref: '#/components/schemas/DataModelCounts'
        startTime:
          type: string
          format: date-time
          nullable: true
        endTime:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
      required:
        - id
        - companyId
        - integrationType
        - dataModels
        - configMode
        - fullSync
        - syncType
        - status
        - jobCounts
        - dataModelCounts
        - startTime
        - endTime
        - createdAt
    SyncJobCounts:
      type: object
      properties:
        total:
          type: number
        success:
          type: number
        failed:
          type: number
        running:
          type: number
        pending:
          type: number
      required:
        - total
        - success
        - failed
        - running
        - pending
    DataModelCounts:
      type: object
      properties:
        total:
          type: number
        success:
          type: number
        failed:
          type: number
        running:
          type: number
        pending:
          type: number
      required:
        - total
        - success
        - failed
        - running
        - pending
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: api_key
      description: Your Commenda Integrations API key, sent in the `api_key` header.

````