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

# Find Custom Scrub Rates (Advanced)

Retrieve a paginated list of custom scrub rate (throttle) settings. Supports search filters, sorting, and pagination to help you find and browse scrub rate configurations programmatically. Note that this endpoint does not return every detail of each setting. For example, it will not return the specific variables associated with a setting. To get those, use the Get by ID endpoint.


## OpenAPI

````yaml openapi/custom-scrub-rates.yaml post /networks/custom/scrubratetable
openapi: 3.0.3
info:
  title: Everflow Network API - Custom Scrub Rates
  description: >
    Endpoints for managing custom scrub rate (throttle) settings in the Everflow
    network. The scrub rate mechanism automatically rejects a percentage of
    conversions for specific affiliate/offer combinations. For more details, see
    the [Performance Data Adjustments
    guide](https://helpdesk.everflow.io/customer/performance-data-adjustments-clicks-conversions-revenue-payout).
  version: 1.0.0
servers:
  - url: https://api.eflow.team/v1
security: []
tags:
  - name: Custom Scrub Rates
paths:
  /networks/custom/scrubratetable:
    post:
      tags:
        - Custom Scrub Rates
      summary: Find Custom Scrub Rates (Advanced)
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number (1-based).
        - in: query
          name: page_size
          schema:
            type: integer
            default: 50
          description: Number of results per page.
        - in: query
          name: relationship
          schema:
            type: string
            enum:
              - all
          description: >-
            Set to `all` to include relationship data (affiliate, offer,
            ruleset) in the response.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
            example:
              filters:
                network_offer_id:
                  values:
                    - 100
                  comparison: is
              sort:
                field: time_created
                direction: desc
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  custom_scrub_rate_settings:
                    type: array
                    items:
                      type: object
                      properties:
                        network_custom_scrub_rate_setting_id:
                          type: integer
                          description: Unique custom scrub rate setting ID.
                        network_id:
                          type: integer
                          description: Network ID.
                        network_affiliate_id:
                          type: integer
                          description: Associated affiliate ID.
                        network_offer_id:
                          type: integer
                          description: Associated offer ID.
                        custom_setting_status:
                          type: string
                          enum:
                            - active
                            - inactive
                          description: Setting status.
                        name:
                          type: string
                          description: Display name for this custom scrub rate setting.
                        scrub_rate_status:
                          type: string
                          enum:
                            - rejected
                            - pending
                          description: How the setting affects the conversions it targets.
                        scrub_rate_percentage:
                          type: integer
                          description: The percentage of conversions affected (0-100).
                        time_created:
                          type: integer
                          example: 1734455015
                          description: Unix timestamp of creation.
                        time_saved:
                          type: integer
                          example: 1734455015
                          description: Unix timestamp of last update.
                        relationship:
                          type: object
                          properties:
                            affiliate:
                              type: object
                              properties:
                                network_affiliate_id:
                                  type: integer
                                network_id:
                                  type: integer
                                name:
                                  type: string
                                account_status:
                                  type: string
                            offer:
                              type: object
                              properties:
                                network_offer_id:
                                  type: integer
                                network_id:
                                  type: integer
                                network_advertiser_id:
                                  type: integer
                                network_offer_group_id:
                                  type: integer
                                name:
                                  type: string
                                offer_status:
                                  type: string
                                network_tracking_domain_id:
                                  type: integer
                                visibility:
                                  type: string
                                currency_id:
                                  type: string
                            ruleset:
                              type: object
                              description: >
                                Targeting ruleset applied to this setting. See
                                the [Ruleset guide](/user-guide/rulesets) for
                                details.
                  paging:
                    $ref: '#/components/schemas/Paging'
      security:
        - API Key: []
components:
  schemas:
    SearchRequest:
      type: object
      properties:
        search_terms:
          type: array
          description: >
            Optional search terms used to look for specific words in setting
            names, offers, or affiliates.
          items:
            type: object
            required:
              - search_type
              - value
            properties:
              search_type:
                type: string
                enum:
                  - name
                  - offer
                  - affiliate
                description: The field to search on.
              value:
                type: string
                description: The search value.
        filters:
          type: object
          description: >
            Optional filters to narrow down the set of settings returned. They
            can be used individually or combined in a single request.
          properties:
            custom_setting_status:
              type: string
              enum:
                - active
                - inactive
              description: |
                Filter on the status of the custom scrub rate setting.
            network_affiliate_ids:
              type: array
              items:
                type: integer
              description: >
                Return only the settings associated with the specified affiliate
                IDs.
            network_offer_ids:
              type: array
              items:
                type: integer
              description: >
                Return only the settings associated with the specified offer
                IDs.
            scrub_rate_status:
              type: string
              enum:
                - rejected
                - pending
              description: |
                Filter on how the setting affects the conversions it targets.
        sort:
          type: object
          properties:
            field:
              type: string
            direction:
              type: string
              enum:
                - asc
                - desc
    Paging:
      type: object
      properties:
        page:
          type: integer
        page_size:
          type: integer
        total_count:
          type: integer
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````