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

# Get Competitor Customer Settings

> Whether Clustr creates renewal tasks in your CRM

Renewal tasks: when a competitor customer becomes `confirmed` and it is one of your CRM accounts
(and not already your customer), Clustr can create one task in your CRM for the account owner,
"Find the renewal date: Initech uses Globex". The task links the evidence, asks the owner to find
out when that contract renews, and quotes the renewal date only if someone already
[recorded one](https://docs.clustr-ai.com/api-reference/set-competitor-customer-verdict.md). It is due
`renewal_task_due_days` after Clustr creates it. Each customer gets at most one task.

Off until an admin turns it on with
[Update Competitor Customer Settings](https://docs.clustr-ai.com/api-reference/update-competitor-customer-settings.md).
`can_edit` says whether you may.

```bash cURL theme={null}
curl https://api.clustr-ai.com/api/public/competitor-customers/settings \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json 200 theme={null}
{
  "success": true,
  "data": {
    "clustr_updated_by_user_id": null,
    "renewal_tasks_enabled": false,
    "renewal_task_due_days": 14,
    "updated_by": null,
    "updated_at": null,
    "can_edit": true
  }
}
```


## OpenAPI

````yaml GET /competitor-customers/settings
openapi: 3.1.0
info:
  title: Clustr Public API
  description: >
    Programmatic access to your Clustr network: import connectors, search warm
    intros (opportunities), and manage target accounts.


    ## Authentication

    All endpoints require a Bearer token (API key) in the `Authorization`
    header.


    ```

    Authorization: Bearer <your_api_key>

    ```


    API keys can be created and managed from the [API settings
    page](https://app.clustr-ai.com/api).
  version: '1.0'
  contact:
    name: Clustr Support
    url: https://clustr-ai.com
servers:
  - url: https://api.clustr-ai.com/api/public
    description: Production
security:
  - BearerAuth: []
paths:
  /competitor-customers/settings:
    get:
      tags:
        - Competitor Monitoring
      summary: Get Competitor Customer Settings
      description: >-
        Returns the renewal task settings: whether Clustr creates a task in your
        CRM for the account owner when a confirmed competitor customer is one of
        your accounts, and when the task is due. Renewal tasks are off by
        default; a workspace admin turns them on.
      operationId: getCompetitorCustomerSettings
      responses:
        '200':
          description: The settings
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/CompetitorCustomerSettings'
        '401':
          description: Invalid or missing API key
        '403':
          description: Competitor monitoring is not enabled for this workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CompetitorCustomerSettings:
      type: object
      properties:
        clustr_updated_by_user_id:
          type: string
          description: >-
            The Clustr ID of the member who last changed it, for example
            `usr_j4gy61g1tdqe6tvhqxqm03f37a`.
          example: usr_j4gy61g1tdqe6tvhqxqm03f37a
        renewal_tasks_enabled:
          type: boolean
          description: >-
            Create a CRM task for the account owner when a confirmed competitor
            customer is one of your accounts.
        renewal_task_due_days:
          type: integer
          minimum: 1
          maximum: 90
          example: 14
        updated_by:
          type: string
          nullable: true
          description: >-
            Kept for integrations built before Clustr IDs. New integrations
            should use `clustr_updated_by_user_id`.
        updated_at:
          type: string
          format: date-time
          nullable: true
        can_edit:
          type: boolean
          description: True for workspace admins, the only role that may change these.
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            message:
              type: string
              example: Invalid request body
            code:
              type: string
              example: BAD_REQUEST
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: The API key you created on the API settings page of the Clustr app.

````

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