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

# Get integration configurations

> Returns the base capabilities and current sync configuration for all connected providers.



## OpenAPI

````yaml /api-reference/openapi.json get /integrations/config
openapi: 3.0.1
info:
  title: Tirdad API
  description: Tirdad API Service
  contact:
    name: API Support
  version: '1.0'
servers:
  - url: https://api.tirdad.ai/v1
    description: Tirdad API
security: []
paths:
  /integrations/config:
    get:
      tags:
        - Integrations
      summary: Get integration configurations
      description: >-
        Returns the base capabilities and current sync configuration for all
        connected providers.
      operationId: getIntegrationConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationConfigResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.ErrorResponse'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: go
          label: Go
          source: "package main\n\nimport(\n\t\"context\"\n\ttirdad \"github.com/tirdad-billing/go-sdk/v2\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := tirdad.New(\n        tirdad.WithSecurity(\"<YOUR_API_KEY_HERE>\"),\n    )\n\n    res, err := s.Integrations.GetIntegrationConfig(ctx)\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.IntegrationConfigResponse != nil {\n        // handle response\n    }\n}"
        - lang: python
          label: Python
          source: |-
            from tirdad_sdk import Tirdad


            with Tirdad(
                api_key_auth="<YOUR_API_KEY_HERE>",
            ) as f_client:

                res = f_client.integrations.get_integration_config()

                # Handle response
                print(res)
        - lang: typescript
          label: TypeScript
          source: |-
            import { Tirdad } from "@tirdad/sdk";

            const tirdad = new Tirdad({
              apiKeyAuth: "<YOUR_API_KEY_HERE>",
            });

            async function run() {
              const result = await tirdad.integrations.getIntegrationConfig();

              console.log(result);
            }

            run();
components:
  schemas:
    IntegrationConfigResponse:
      type: object
      properties:
        integrations:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationConfigEntry'
    errors.ErrorResponse:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/errors.ErrorCode'
        http_status_code:
          type: integer
        message:
          type: string
      x-speakeasy-name-override: ErrorResponse
    IntegrationConfigEntry:
      type: object
      properties:
        base_config:
          $ref: '#/components/schemas/types.SyncConfig'
        current_config:
          $ref: '#/components/schemas/types.SyncConfig'
        provider:
          $ref: '#/components/schemas/types.SecretProvider'
    errors.ErrorCode:
      type: string
      enum:
        - http_client_error
        - system_error
        - internal_error
        - not_found
        - already_exists
        - version_conflict
        - validation_error
        - invalid_operation
        - permission_denied
        - database_error
        - service_unavailable
        - too_many_requests
        - not_implemented
      x-enum-varnames:
        - ErrCodeHTTPClient
        - ErrCodeSystemError
        - ErrCodeInternalError
        - ErrCodeNotFound
        - ErrCodeAlreadyExists
        - ErrCodeVersionConflict
        - ErrCodeValidation
        - ErrCodeInvalidOperation
        - ErrCodePermissionDenied
        - ErrCodeDatabase
        - ErrCodeServiceUnavailable
        - ErrCodeTooManyRequests
        - ErrCodeNotImplemented
      x-speakeasy-name-override: ErrorCode
    types.SyncConfig:
      type: object
      properties:
        aws_marketplace:
          $ref: '#/components/schemas/types.AWSMarketplaceSyncConfig'
        customer:
          $ref: '#/components/schemas/types.EntitySyncConfig'
        deal:
          $ref: '#/components/schemas/types.EntitySyncConfig'
        invoice:
          $ref: '#/components/schemas/types.EntitySyncConfig'
        invoice_sync_settings:
          $ref: '#/components/schemas/types.InvoiceSyncSettings'
        payment:
          $ref: '#/components/schemas/types.EntitySyncConfig'
        plan:
          $ref: '#/components/schemas/types.EntitySyncConfig'
        price:
          $ref: '#/components/schemas/types.EntitySyncConfig'
        quote:
          $ref: '#/components/schemas/types.EntitySyncConfig'
        s3:
          $ref: '#/components/schemas/types.StorageExportConfig'
        subscription:
          $ref: '#/components/schemas/types.EntitySyncConfig'
      x-speakeasy-name-override: SyncConfig
    types.SecretProvider:
      type: string
      enum:
        - tirdad
        - stripe
        - s3
        - gcs
        - hubspot
        - razorpay
        - chargebee
        - quickbooks
        - zoho_books
        - nomod
        - moyasar
        - paddle
        - whop
        - tabs
        - aws_marketplace
        - gcp_marketplace
        - azure_marketplace
      x-enum-comments:
        SecretProviderAzureMarketplace: '#nosec G101 -- provider enum value, not a secret'
        SecretProviderGCS: >-
          supports multiple connections per environment, service-account JSON
          creds
        SecretProviderQuickBooks: '#nosec G101 -- enum value name, not a secret'
        SecretProviderS3: supports multiple connections per environment
      x-enum-varnames:
        - SecretProviderTirdad
        - SecretProviderStripe
        - SecretProviderS3
        - SecretProviderGCS
        - SecretProviderHubSpot
        - SecretProviderRazorpay
        - SecretProviderChargebee
        - SecretProviderQuickBooks
        - SecretProviderZohoBooks
        - SecretProviderNomod
        - SecretProviderMoyasar
        - SecretProviderPaddle
        - SecretProviderWhop
        - SecretProviderTabs
        - SecretProviderAWSMarketplace
        - SecretProviderGCPMarketplace
        - SecretProviderAzureMarketplace
      x-speakeasy-name-override: SecretProvider
    types.AWSMarketplaceSyncConfig:
      type: object
      properties:
        region:
          type: string
      x-speakeasy-name-override: AWSMarketplaceSyncConfig
    types.EntitySyncConfig:
      type: object
      properties:
        inbound:
          type: boolean
          description: Inbound from external provider to Tirdad
        outbound:
          type: boolean
          description: Outbound from Tirdad to external provider
      x-speakeasy-name-override: EntitySyncConfig
    types.InvoiceSyncSettings:
      type: object
      properties:
        deposit_to_account_id:
          type: string
          description: >-
            Zoho chart-of-accounts id ("Deposit To"). Empty omits account_id,
            leaving Zoho's

            Undeposited Funds default.a
        global_custom_fields:
          type: array
          description: >-
            Fixed values written to Zoho invoice custom fields on every sync,
            independent of

            any metadata source.
          items:
            $ref: '#/components/schemas/types.GlobalCustomField'
        metadata_custom_fields:
          type: array
          description: Copies metadata values onto Zoho invoice custom fields verbatim.
          items:
            $ref: '#/components/schemas/types.MetadataCustomField'
        normalize_fixed_to:
          $ref: '#/components/schemas/types.BillingPeriod'
        payment_mode:
          type: string
          description: >-
            Zoho payment modes are merchant-editable free strings with no id, so
            this is passed

            through verbatim. Empty means DefaultZohoPaymentMode.
        service_period_custom_fields:
          $ref: '#/components/schemas/types.ServicePeriodCustomFields'
        submit_for_approval:
          type: boolean
          description: >-
            Zoho rejects payments on draft invoices, and merchants configure a
            Zoho auto-approval

            rule for Tirdad-sent invoices, so we submit, wait for that rule to
            fire, then pay.
      x-speakeasy-name-override: InvoiceSyncSettings
    types.StorageExportConfig:
      type: object
      properties:
        bucket:
          type: string
          description: Storage bucket name
        compression:
          $ref: '#/components/schemas/types.S3CompressionType'
        encryption:
          $ref: '#/components/schemas/types.S3EncryptionType'
        is_tirdad_managed:
          type: boolean
          description: >-
            If true, use Tirdad-managed storage credentials instead of
            user-provided
        key_prefix:
          type: string
          description: Optional prefix for object keys (e.g., "tirdad-exports/")
        region:
          type: string
          description: Cloud region (e.g., "us-west-2"); unused for GCS
      x-speakeasy-name-override: StorageExportConfig
    types.GlobalCustomField:
      type: object
      properties:
        field:
          type: string
        value:
          type: string
      x-speakeasy-name-override: GlobalCustomField
    types.MetadataCustomField:
      type: object
      properties:
        field:
          type: string
        metadata_key:
          type: string
        source:
          $ref: '#/components/schemas/types.MetadataCustomFieldSource'
      x-speakeasy-name-override: MetadataCustomField
    types.BillingPeriod:
      type: string
      enum:
        - MONTHLY
        - ANNUAL
        - WEEKLY
        - DAILY
        - QUARTERLY
        - HALF_YEARLY
        - ONETIME
      x-enum-varnames:
        - BILLING_PERIOD_MONTHLY
        - BILLING_PERIOD_ANNUAL
        - BILLING_PERIOD_WEEKLY
        - BILLING_PERIOD_DAILY
        - BILLING_PERIOD_QUARTER
        - BILLING_PERIOD_HALF_YEAR
        - BILLING_PERIOD_ONETIME
      x-speakeasy-name-override: BillingPeriod
    types.ServicePeriodCustomFields:
      type: object
      properties:
        end_field_id:
          type: string
        start_field_id:
          type: string
      x-speakeasy-name-override: ServicePeriodCustomFields
    types.S3CompressionType:
      type: string
      enum:
        - none
        - gzip
      x-enum-varnames:
        - S3CompressionTypeNone
        - S3CompressionTypeGzip
      x-speakeasy-name-override: S3CompressionType
    types.S3EncryptionType:
      type: string
      enum:
        - AES256
        - aws:kms
        - aws:kms:dsse
      x-enum-varnames:
        - S3EncryptionTypeAES256
        - S3EncryptionTypeAwsKms
        - S3EncryptionTypeAwsKmsDsse
      x-speakeasy-name-override: S3EncryptionType
    types.MetadataCustomFieldSource:
      type: string
      enum:
        - customer
        - invoice
      x-enum-varnames:
        - MetadataCustomFieldSourceCustomer
        - MetadataCustomFieldSourceInvoice
      x-speakeasy-name-override: MetadataCustomFieldSource
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Enter your API key in the format *x-api-key &lt;api-key&gt;**
      name: x-api-key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.