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

# CARF schedule and review settings



## OpenAPI

````yaml /api-reference/platform-api.json get /v2/workflows/{workflowId}/carf/settings
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.37
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/workflows/{workflowId}/carf/settings:
    get:
      tags:
        - CARF
      summary: CARF schedule and review settings
      operationId: getSettings
      parameters:
        - name: workflowId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarfWorkflowSettingsDto'
components:
  schemas:
    CarfWorkflowSettingsDto:
      type: object
      properties:
        granularity:
          type: string
          enum:
            - manual
            - daily
            - weekly
            - monthly
            - quarterly
            - annual
          description: >-
            How often a report is generated, each covering the Europe/London
            period that just closed. manual: only on request.
        week_start:
          type: number
          minimum: 0
          maximum: 6
          description: 'First day of a weekly period: 0 Sunday … 6 Saturday.'
        review_required:
          type: boolean
          description: >-
            Hold each report for review before it is sent; otherwise send it as
            soon as it is generated.
        updated_at:
          type: string
          nullable: true
      required:
        - granularity
        - week_start
        - review_required
        - updated_at
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

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