> ## 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.

# Get



## OpenAPI

````yaml /openapi_v4_core.json get /v4/core/invite-links/{inviteLinkUuid}
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/invite-links/{inviteLinkUuid}:
    get:
      tags:
        - Invite Links
      summary: Get
      operationId: InviteLinkCoreController_getByInviteLinkUuid
      parameters:
        - name: inviteLinkUuid
          required: true
          in: path
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The requested invite link with its data model configs.
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/InviteLinkDetailResponse'
                  request_id:
                    type: string
                    format: uuid
                required:
                  - data
                  - request_id
      security:
        - api_key: []
components:
  schemas:
    InviteLinkDetailResponse:
      type: object
      properties:
        inviteLink:
          $ref: '#/components/schemas/SerializedInviteLinkDetail'
      required:
        - inviteLink
    SerializedInviteLinkDetail:
      type: object
      properties:
        id:
          type: number
        inviteLinkId:
          type: string
        companyId:
          type: number
          nullable: true
        integration:
          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
        integrationCategory:
          type: string
          enum:
            - ACCOUNTING
            - PAYMENTS
            - ECOMMERCE
            - CRM
            - HRIS
        syncFrom:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
        dataModelConfigs:
          type: array
          items:
            $ref: '#/components/schemas/DataModelSyncConfigResponse'
      required:
        - id
        - inviteLinkId
        - companyId
        - integration
        - integrationCategory
        - syncFrom
        - createdAt
        - dataModelConfigs
    DataModelSyncConfigResponse:
      type: object
      properties:
        dataModel:
          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
        category:
          type: string
          enum:
            - ACCOUNTING
            - PAYMENTS
            - ECOMMERCE
            - CRM
            - HRIS
        enabled:
          type: boolean
        scopeAccess:
          $ref: '#/components/schemas/ScopeAccessResponse'
        frequency:
          type: string
          enum:
            - WEEKLY
            - MONTHLY
            - YEARLY
            - DAILY
            - HOURLY
            - NEVER
        interval:
          type: number
        syncFrom:
          type: string
          nullable: true
        isOverridden:
          type: boolean
        isChild:
          type: boolean
      required:
        - dataModel
        - category
        - enabled
        - scopeAccess
        - frequency
        - interval
        - syncFrom
        - isOverridden
        - isChild
    ScopeAccessResponse:
      type: object
      properties:
        READ:
          type: boolean
        CREATE:
          type: boolean
        UPDATE:
          type: boolean
        DELETE:
          type: boolean
      required:
        - READ
        - CREATE
        - UPDATE
        - DELETE
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: api_key
      description: Your Commenda Integrations API key, sent in the `api_key` header.

````