Rulebase Export Runs API
The Export Runs API from Rulebase — 3 operation(s) for export runs.
The Export Runs API from Rulebase — 3 operation(s) for export runs.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/rulebase:rulebase-export-runs-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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: 3.2.0
info:
title: Rulebase API2 Export Runs API
version: 0.0.1
tags:
- name: Export Runs
paths:
/export-runs:
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: []
delivery:
type: string
enum:
- download
- email
required:
- exportType
responses:
'202':
description: Export queued
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
message:
type: string
exportRun:
type: object
properties:
id:
type: string
organizationId:
type: string
exportScheduleId:
type: string
nullable: true
requestedByMembershipId:
type: string
nullable: true
requestedBy:
type: object
nullable: true
properties:
name:
type: string
nullable: true
email:
type: string
required:
- name
- email
source:
type: string
enum:
- manual
- scheduled
exportType:
type: string
enum:
- qa_tickets
- qa_evaluations
- all_interactions
- work_items
- complaints
- coaching_sessions
filters:
type: object
additionalProperties:
nullable: true
fieldKeys:
type: array
items:
type: string
recipients:
type: array
items:
type: string
status:
type: string
enum:
- queued
- running
- succeeded
- failed
requestedAt:
type: string
startedAt:
type: string
nullable: true
completedAt:
type: string
nullable: true
emailedAt:
type: string
nullable: true
errorMessage:
type: string
nullable: true
attachment:
type: object
nullable: true
properties:
filename:
type: string
contentType:
type: string
fileSizeBytes:
type: number
nullable: true
downloadUrl:
type: string
required:
- filename
- contentType
- fileSizeBytes
- downloadUrl
emailResults:
type: array
items:
type: object
properties:
recipient:
type: string
ok:
type: boolean
providerMessageId:
type: string
error:
type: string
required:
- recipient
- ok
createdAt:
type: string
updatedAt:
type: string
required:
- id
- organizationId
- exportScheduleId
- requestedByMembershipId
- requestedBy
- source
- exportType
- filters
- fieldKeys
- recipients
- status
- requestedAt
- startedAt
- completedAt
- emailedAt
- errorMessage
- attachment
- emailResults
- createdAt
- updatedAt
required:
- message
- exportRun
required:
- data
'400':
description: Invalid export request
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 Runs
summary: Create export runs
x-summary-source: derived
operationId: postExportRuns
x-operation-id-source: derived
get:
parameters:
- schema:
type: string
required: false
name: scheduleId
in: query
responses:
'200':
description: List export runs
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
organizationId:
type: string
exportScheduleId:
type: string
nullable: true
requestedByMembershipId:
type: string
nullable: true
requestedBy:
type: object
nullable: true
properties:
name:
type: string
nullable: true
email:
type: string
required:
- name
- email
source:
type: string
enum:
- manual
- scheduled
exportType:
type: string
enum:
- qa_tickets
- qa_evaluations
- all_interactions
- work_items
- complaints
- coaching_sessions
filters:
type: object
additionalProperties:
nullable: true
fieldKeys:
type: array
items:
type: string
recipients:
type: array
items:
type: string
status:
type: string
enum:
- queued
- running
- succeeded
- failed
requestedAt:
type: string
startedAt:
type: string
nullable: true
completedAt:
type: string
nullable: true
emailedAt:
type: string
nullable: true
errorMessage:
type: string
nullable: true
attachment:
type: object
nullable: true
properties:
filename:
type: string
contentType:
type: string
fileSizeBytes:
type: number
nullable: true
downloadUrl:
type: string
required:
- filename
- contentType
- fileSizeBytes
- downloadUrl
emailResults:
type: array
items:
type: object
properties:
recipient:
type: string
ok:
type: boolean
providerMessageId:
type: string
error:
type: string
required:
- recipient
- ok
createdAt:
type: string
updatedAt:
type: string
required:
- id
- organizationId
- exportScheduleId
- requestedByMembershipId
- requestedBy
- source
- exportType
- filters
- fieldKeys
- recipients
- status
- requestedAt
- startedAt
- completedAt
- emailedAt
- errorMessage
- attachment
- emailResults
- createdAt
- updatedAt
required:
- data
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Export Runs
summary: Get export runs
x-summary-source: derived
operationId: getExportRuns
x-operation-id-source: derived
/export-runs/{id}/download:
get:
parameters:
- schema:
type: string
required: true
name: id
in: path
responses:
'200':
description: Export attachment
content:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
type: string
format: binary
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'404':
description: Export run not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'409':
description: Export run has no completed attachment
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Export Runs
summary: Get export runs by id download
x-summary-source: derived
operationId: getExportRunsByIdDownload
x-operation-id-source: derived
/export-runs/{id}:
delete:
parameters:
- schema:
type: string
required: true
name: id
in: path
responses:
'204':
description: Export run deleted
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'404':
description: Export run not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Export Runs
summary: Delete export runs by id
x-summary-source: derived
operationId: deleteExportRunsById
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Rulebase organization API key