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

# Get the CRM write-back settings

> Which changes made in Statisfy are written back to the workspace's CRM: accounts (and to Gainsight), opportunities and the ones created there, contacts and tasks. A setting that does not apply (no CRM, or no Gainsight, connected) is null. Read only: change them in the app.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/settings/crm-sync
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/settings/crm-sync:
    get:
      tags:
        - settings
      summary: Get the CRM write-back settings
      description: >-
        Which changes made in Statisfy are written back to the workspace's CRM:
        accounts (and to Gainsight), opportunities and the ones created there,
        contacts and tasks. A setting that does not apply (no CRM, or no
        Gainsight, connected) is null. Read only: change them in the app.
      operationId: settings_crm_sync_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmSync'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    CrmSync:
      examples:
        - accounts: true
          contacts: false
          opportunities: true
          opportunities_created:
            and:
              - field: type
                object: opportunity
                op: eq
                value: New Business
          tasks: true
      properties:
        accounts:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            Whether account changes made in Statisfy are written back to the
            CRM; null when no CRM is connected
          title: Accounts
        accounts_to_gainsight:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            Whether account changes made in Statisfy are written back to
            Gainsight; null when Gainsight or no CRM is connected
          title: Accounts To Gainsight
        contacts:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            Whether contact changes made in Statisfy are written back to the
            CRM; null when no CRM is connected
          title: Contacts
        opportunities:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            Whether opportunity changes made in Statisfy are written back to the
            CRM; null when no CRM is connected
          title: Opportunities
        opportunities_created:
          anyOf:
            - $ref: '#/components/schemas/ConditionView'
            - $ref: '#/components/schemas/GroupView'
            - type: 'null'
          description: >-
            Which opportunities made in Statisfy are created in the CRM: a
            condition on an opportunity field, or an `and` or `or` group of
            them, as notification rules give their conditions. Null: all of them
            (no filter is saved), or no CRM is connected (then `accounts` is
            null too)
          title: Opportunities Created
        tasks:
          description: Whether task changes made in Statisfy are written back to the CRM
          title: Tasks
          type: boolean
      required:
        - accounts
        - accounts_to_gainsight
        - opportunities
        - opportunities_created
        - contacts
        - tasks
      title: CrmSync
      type: object
    ConditionView:
      properties:
        field:
          title: Field
          type: string
        object:
          description: 'The object the field is on: account, user, opportunity, ...'
          title: Object
          type: string
        op:
          title: Op
          type: string
        value:
          title: Value
      required:
        - object
        - field
        - op
      title: ConditionView
      type: object
    GroupView:
      properties:
        and:
          anyOf:
            - items:
                anyOf:
                  - $ref: '#/components/schemas/ConditionView'
                  - $ref: '#/components/schemas/GroupView'
              type: array
            - type: 'null'
          description: All of these
          title: And
        or:
          anyOf:
            - items:
                anyOf:
                  - $ref: '#/components/schemas/ConditionView'
                  - $ref: '#/components/schemas/GroupView'
              type: array
            - type: 'null'
          description: Any of these
          title: Or
      title: GroupView
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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