Rulebase Export Schedules API

The Export Schedules API from Rulebase — 4 operation(s) for export schedules.

Operations 7

GET /export-schedules Get export schedules #
POST /export-schedules Create export schedules #
GET /export-schedules/{id} Get export schedules by id #
PATCH /export-schedules/{id} Update export schedules by id #
DELETE /export-schedules/{id} Delete export schedules by id #
POST /export-schedules/preview Create export schedules preview #
POST /export-schedules/{id}/send Create export schedules by id send #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/rulebase:rulebase-export-schedules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rulebase-export-schedules-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Rulebase API2 Export Schedules API
  version: 0.0.1
tags:
- name: Export Schedules
paths:
  /export-schedules:
    get:
      responses:
        '200':
          description: List visible recurring exports
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        organizationId:
                          type: string
                        createdByMembershipId:
                          type: string
                          nullable: true
                        exportType:
                          type: string
                          enum:
                          - qa_tickets
                          - qa_evaluations
                          - all_interactions
                          - work_items
                          - complaints
                          - coaching_sessions
                        filters:
                          type: object
                          additionalProperties:
                            nullable: true
                          default: {}
                        fieldKeys:
                          type: array
                          items:
                            type: string
                          default: []
                        frequency:
                          type: string
                          enum:
                          - daily
                          - weekly
                        dayOfWeek:
                          type: integer
                          minimum: 0
                          maximum: 6
                        timeOfDay:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        timezone:
                          type: string
                          minLength: 1
                        recipients:
                          type: array
                          items:
                            type: string
                          minItems: 1
                        nextRunAt:
                          type: string
                          nullable: true
                        lastRunAt:
                          type: string
                          nullable: true
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                        canEdit:
                          type: boolean
                      required:
                      - id
                      - organizationId
                      - createdByMembershipId
                      - exportType
                      - frequency
                      - dayOfWeek
                      - timeOfDay
                      - timezone
                      - recipients
                      - nextRunAt
                      - lastRunAt
                      - createdAt
                      - updatedAt
                      - canEdit
                required:
                - data
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Export Schedules
      summary: Get export schedules
      x-summary-source: derived
      operationId: getExportSchedules
      x-operation-id-source: derived
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                exportType:
                  type: string
                  enum:
                  - qa_tickets
                  - qa_evaluations
                  - all_interactions
                  - complaints
                  - coaching_sessions
                filters:
                  type: object
                  additionalProperties:
                    nullable: true
                  default: {}
                fieldKeys:
                  type: array
                  items:
                    type: string
                  default: []
                frequency:
                  type: string
                  enum:
                  - daily
                  - weekly
                  default: weekly
                dayOfWeek:
                  type: integer
                  minimum: 0
                  maximum: 6
                timeOfDay:
                  type: string
                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                timezone:
                  type: string
                  minLength: 1
                recipients:
                  type: array
                  items:
                    type: string
                  minItems: 1
              required:
              - exportType
              - dayOfWeek
              - timeOfDay
              - recipients
      responses:
        '201':
          description: Recurring export created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organizationId:
                        type: string
                      createdByMembershipId:
                        type: string
                        nullable: true
                      exportType:
                        type: string
                        enum:
                        - qa_tickets
                        - qa_evaluations
                        - all_interactions
                        - work_items
                        - complaints
                        - coaching_sessions
                      filters:
                        type: object
                        additionalProperties:
                          nullable: true
                        default: {}
                      fieldKeys:
                        type: array
                        items:
                          type: string
                        default: []
                      frequency:
                        type: string
                        enum:
                        - daily
                        - weekly
                      dayOfWeek:
                        type: integer
                        minimum: 0
                        maximum: 6
                      timeOfDay:
                        type: string
                        pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      timezone:
                        type: string
                        minLength: 1
                      recipients:
                        type: array
                        items:
                          type: string
                        minItems: 1
                      nextRunAt:
                        type: string
                        nullable: true
                      lastRunAt:
                        type: string
                        nullable: true
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      canEdit:
                        type: boolean
                    required:
                    - id
                    - organizationId
                    - createdByMembershipId
                    - exportType
                    - frequency
                    - dayOfWeek
                    - timeOfDay
                    - timezone
                    - recipients
                    - nextRunAt
                    - lastRunAt
                    - createdAt
                    - updatedAt
                    - canEdit
                required:
                - data
        '400':
          description: Invalid recurring export
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Export Schedules
      summary: Create export schedules
      x-summary-source: derived
      operationId: postExportSchedules
      x-operation-id-source: derived
  /export-schedules/{id}:
    get:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Recurring export found
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organizationId:
                        type: string
                      createdByMembershipId:
                        type: string
                        nullable: true
                      exportType:
                        type: string
                        enum:
                        - qa_tickets
                        - qa_evaluations
                        - all_interactions
                        - work_items
                        - complaints
                        - coaching_sessions
                      filters:
                        type: object
                        additionalProperties:
                          nullable: true
                        default: {}
                      fieldKeys:
                        type: array
                        items:
                          type: string
                        default: []
                      frequency:
                        type: string
                        enum:
                        - daily
                        - weekly
                      dayOfWeek:
                        type: integer
                        minimum: 0
                        maximum: 6
                      timeOfDay:
                        type: string
                        pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      timezone:
                        type: string
                        minLength: 1
                      recipients:
                        type: array
                        items:
                          type: string
                        minItems: 1
                      nextRunAt:
                        type: string
                        nullable: true
                      lastRunAt:
                        type: string
                        nullable: true
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      canEdit:
                        type: boolean
                    required:
                    - id
                    - organizationId
                    - createdByMembershipId
                    - exportType
                    - frequency
                    - dayOfWeek
                    - timeOfDay
                    - timezone
                    - recipients
                    - nextRunAt
                    - lastRunAt
                    - createdAt
                    - updatedAt
                    - canEdit
                required:
                - data
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Recurring export not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Export Schedules
      summary: Get export schedules by id
      x-summary-source: derived
      operationId: getExportSchedulesById
      x-operation-id-source: derived
    patch:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                exportType:
                  type: string
                  enum:
                  - qa_tickets
                  - qa_evaluations
                  - all_interactions
                  - complaints
                  - coaching_sessions
                filters:
                  type: object
                  additionalProperties:
                    nullable: true
                  default: {}
                fieldKeys:
                  type: array
                  items:
                    type: string
                  default: []
                frequency:
                  type: string
                  enum:
                  - daily
                  - weekly
                dayOfWeek:
                  type: integer
                  minimum: 0
                  maximum: 6
                timeOfDay:
                  type: string
                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                timezone:
                  type: string
                  minLength: 1
                recipients:
                  type: array
                  items:
                    type: string
                  minItems: 1
      responses:
        '200':
          description: Recurring export updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organizationId:
                        type: string
                      createdByMembershipId:
                        type: string
                        nullable: true
                      exportType:
                        type: string
                        enum:
                        - qa_tickets
                        - qa_evaluations
                        - all_interactions
                        - work_items
                        - complaints
                        - coaching_sessions
                      filters:
                        type: object
                        additionalProperties:
                          nullable: true
                        default: {}
                      fieldKeys:
                        type: array
                        items:
                          type: string
                        default: []
                      frequency:
                        type: string
                        enum:
                        - daily
                        - weekly
                      dayOfWeek:
                        type: integer
                        minimum: 0
                        maximum: 6
                      timeOfDay:
                        type: string
                        pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      timezone:
                        type: string
                        minLength: 1
                      recipients:
                        type: array
                        items:
                          type: string
                        minItems: 1
                      nextRunAt:
                        type: string
                        nullable: true
                      lastRunAt:
                        type: string
                        nullable: true
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      canEdit:
                        type: boolean
                    required:
                    - id
                    - organizationId
                    - createdByMembershipId
                    - exportType
                    - frequency
                    - dayOfWeek
                    - timeOfDay
                    - timezone
                    - recipients
                    - nextRunAt
                    - lastRunAt
                    - createdAt
                    - updatedAt
                    - canEdit
                required:
                - data
        '400':
          description: Invalid recurring export
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Recurring export not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Export Schedules
      summary: Update export schedules by id
      x-summary-source: derived
      operationId: patchExportSchedulesById
      x-operation-id-source: derived
    delete:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Recurring export deleted
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Recurring export not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Export Schedules
      summary: Delete export schedules by id
      x-summary-source: derived
      operationId: deleteExportSchedulesById
      x-operation-id-source: derived
  /export-schedules/preview:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                exportType:
                  type: string
                  enum:
                  - qa_tickets
                  - qa_evaluations
                  - all_interactions
                  - work_items
                  - complaints
                  - coaching_sessions
                filters:
                  type: object
                  additionalProperties:
                    nullable: true
                  default: {}
                fieldKeys:
                  type: array
                  items:
                    type: string
                  default: []
              required:
              - exportType
      responses:
        '200':
          description: Recurring export preview
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      headers:
                        type: array
                        items:
                          type: string
                      headerRows:
                        type: array
                        items:
                          type: array
                          items:
                            type: string
                      rows:
                        type: array
                        items:
                          type: array
                          items:
                            type: string
                    required:
                    - headers
                    - rows
                required:
                - data
        '400':
          description: Invalid recurring export preview
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Export Schedules
      summary: Create export schedules preview
      x-summary-source: derived
      operationId: postExportSchedulesPreview
      x-operation-id-source: derived
  /export-schedules/{id}/send:
    post:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '202':
          description: Recurring export enqueued
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organizationId:
                        type: string
                      createdByMembershipId:
                        type: string
                        nullable: true
                      exportType:
                        type: string
                        enum:
                        - qa_tickets
                        - qa_evaluations
                        - all_interactions
                        - work_items
                        - complaints
                        - coaching_sessions
                      filters:
                        type: object
                        additionalProperties:
                          nullable: true
                        default: {}
                      fieldKeys:
                        type: array
                        items:
                          type: string
                        default: []
                      frequency:
                        type: string
                        enum:
                        - daily
                        - weekly
                      dayOfWeek:
                        type: integer
                        minimum: 0
                        maximum: 6
                      timeOfDay:
                        type: string
                        pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      timezone:
                        type: string
                        minLength: 1
                      recipients:
                        type: array
                        items:
                          type: string
                        minItems: 1
                      nextRunAt:
                        type: string
                        nullable: true
                      lastRunAt:
                        type: string
                        nullable: true
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      canEdit:
                        type: boolean
                    required:
                    - id
                    - organizationId
                    - createdByMembershipId
                    - exportType
                    - frequency
                    - dayOfWeek
                    - timeOfDay
                    - timezone
                    - recipients
                    - nextRunAt
                    - lastRunAt
                    - createdAt
                    - updatedAt
                    - canEdit
                required:
                - data
        '400':
          description: Recurring export cannot be sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Recurring export not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Export Schedules
      summary: Create export schedules by id send
      x-summary-source: derived
      operationId: postExportSchedulesByIdSend
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key