Gladly REST API — Export

naftiko: 1.0.0-alpha2
info:
  label: Gladly REST API — Export
  description: Gladly REST API — Export. 5 operations. Self-contained Naftiko capability covering the Export business surface
    of the Gladly Customer Service Platform.
  tags:
  - Gladly
  - Export
  - Customer Service
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
- namespace: env
  keys:
    GLADLY_ORGANIZATION: GLADLY_ORGANIZATION
    GLADLY_AGENT_EMAIL: GLADLY_AGENT_EMAIL
    GLADLY_API_TOKEN: GLADLY_API_TOKEN
capability:
  consumes:
  - type: http
    namespace: gladly-export
    baseUri: https://{{env.GLADLY_ORGANIZATION}}.gladly.com
    description: Gladly REST API — Export business capability.
    resources:
    - name: api-v1-export-schedules
      path: /api/v1/export/schedules
      operations:
      - name: findSchedules
        method: GET
        description: List Schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: api-v1-export-jobs
      path: /api/v1/export/jobs
      operations:
      - name: findJobs
        method: GET
        description: List Jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          required: false
          description: export job status to search on.
        - name: startAt
          in: query
          type: string
          required: false
          description: 'Starting time to filter export jobs by. This is based on the `updatedAt` field which indicates when
            the job was last updated. Cannot be more than 14 days ago. Default is 14 days ago.


            The date should be in ISO 8601 format.

            '
        - name: endAt
          in: query
          type: string
          required: false
          description: 'Ending time to filter export jobs by. This is based on the `updatedAt` field which indicates when
            the job was last updated. Cannot be before ''startAt'' or in the future. Default is now.


            The date should be in ISO 8601 format.

            '
    - name: api-v1-export-jobs-jobId
      path: /api/v1/export/jobs/{jobId}
      operations:
      - name: getJob
        method: GET
        description: Get Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
      - name: deleteJob
        method: DELETE
        description: Delete Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: api-v1-export-jobs-jobId-files-filename
      path: /api/v1/export/jobs/{jobId}/files/{filename}
      operations:
      - name: getFile
        method: GET
        description: Get File
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          required: true
          description: id of the job
        - name: filename
          in: path
          type: string
          required: true
          description: name of the file
    authentication:
      type: basic
      username: '{{env.GLADLY_AGENT_EMAIL}}'
      password: '{{env.GLADLY_API_TOKEN}}'
  exposes:
  - type: rest
    namespace: gladly-export-rest
    port: 8080
    description: REST adapter for Gladly Export.
    resources:
    - path: /v1/api/v1/export/schedules
      name: api-v1-export-schedules
      description: REST surface for api-v1-export-schedules.
      operations:
      - method: GET
        name: findSchedules
        description: List Schedules
        call: gladly-export.findSchedules
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/export/jobs
      name: api-v1-export-jobs
      description: REST surface for api-v1-export-jobs.
      operations:
      - method: GET
        name: findJobs
        description: List Jobs
        call: gladly-export.findJobs
        with:
          status: rest.query.status
          startAt: rest.query.startAt
          endAt: rest.query.endAt
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/export/jobs/{jobId}
      name: api-v1-export-jobs-jobId
      description: REST surface for api-v1-export-jobs-jobId.
      operations:
      - method: GET
        name: getJob
        description: Get Job
        call: gladly-export.getJob
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/export/jobs/{jobId}
      name: api-v1-export-jobs-jobId
      description: REST surface for api-v1-export-jobs-jobId.
      operations:
      - method: DELETE
        name: deleteJob
        description: Delete Job
        call: gladly-export.deleteJob
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/export/jobs/{jobId}/files/{filename}
      name: api-v1-export-jobs-jobId-files-filename
      description: REST surface for api-v1-export-jobs-jobId-files-filename.
      operations:
      - method: GET
        name: getFile
        description: Get File
        call: gladly-export.getFile
        with:
          jobId: rest.path.jobId
          filename: rest.path.filename
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: gladly-export-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gladly Export.
    tools:
    - name: gladly-findSchedules
      description: List Schedules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gladly-export.findSchedules
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: gladly-findJobs
      description: List Jobs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gladly-export.findJobs
      with:
        status: tools.status
        startAt: tools.startAt
        endAt: tools.endAt
      outputParameters:
      - type: object
        mapping: $.
    - name: gladly-getJob
      description: Get Job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gladly-export.getJob
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: gladly-deleteJob
      description: Delete Job
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: gladly-export.deleteJob
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: gladly-getFile
      description: Get File
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gladly-export.getFile
      with:
        jobId: tools.jobId
        filename: tools.filename
      outputParameters:
      - type: object
        mapping: $.