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

# Get contest settings

> Get the vendor's contest settings including sync status and pause flags.
Requires the `enableVendorContests` feature to be enabled.




## OpenAPI

````yaml /openapi.yaml get /contests/settings
openapi: 3.0.3
info:
  title: RenovationFind API
  description: >
    Public REST API for RenovationFind vendor integrations.


    ## Authentication

    All endpoints require a Bearer token in the `Authorization` header.

    Tokens are issued from the RenovationFind Manager Portal.


    ```

    Authorization: Bearer <your_jwt_token>

    ```


    ## Rate Limiting

    API requests are rate-limited to **250 requests per 5 minutes** per vendor.

    When exceeded, the API returns `429 Too Many Requests` with a `Retry-After`
    header.


    ## Response Format

    All responses follow a consistent envelope:

    ```json

    {
      "success": true,
      "data": { ... },
      "message": "Optional message"
    }

    ```

    On error:

    ```json

    {
      "success": false,
      "error": "Error description"
    }

    ```
  version: 1.0.0
  contact:
    name: RenovationFind
    url: https://www.renovationfind.com
servers:
  - url: https://www.renovationfind.com/rest-api-v1
    description: Production
security:
  - BearerAuth: []
paths:
  /contests/settings:
    get:
      tags:
        - Vendor Contests
      summary: Get contest settings
      description: |
        Get the vendor's contest settings including sync status and pause flags.
        Requires the `enableVendorContests` feature to be enabled.
      operationId: getContestVendorSettings
      responses:
        '200':
          description: Contest settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    description: Vendor contest settings and sync status
                    properties:
                      id:
                        type: integer
                        format: int64
                      dateCreated:
                        type: string
                        format: date-time
                      dateModified:
                        type: string
                        format: date-time
                      vendorId:
                        type: integer
                        format: int64
                      syncOngoing:
                        type: boolean
                        description: >-
                          Whether a CFS-to-contests sync is currently in
                          progress
                      lastSyncStarted:
                        type: string
                        format: date-time
                        nullable: true
                        description: When the last sync was started
                      pauseCurrentDripsInPipeline:
                        type: boolean
                        description: >-
                          If true, existing participants in the drip pipeline
                          will not receive notifications
                      pauseVendorContestDrippingFromCFS:
                        type: boolean
                        description: >-
                          If true, new CFS records will not be synced to the
                          contest pipeline
        '403':
          description: Vendor contests not enabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
        '429':
          description: Rate limit exceeded (250 requests per 5 minutes)
          headers:
            Retry-After:
              schema:
                type: integer
                example: 300
              description: Seconds to wait before retrying
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
              example:
                success: false
                error: >-
                  Rate limit exceeded. Maximum 250 requests per 5 minutes.
                  Please retry later.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token issued from the RenovationFind Manager Portal

````