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/mammoth-io:mammoth-io-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Mammoth Io Schedules API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Schedules across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Schedules
paths:
  /workspaces/{workspace_id}/projects/{project_id}/schedules:
    get:
      tags:
      - Schedules
      summary: Get list of schedules
      operationId: ListSchedules
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: fields
        in: query
        schema:
          type: string
          title: Fields
          description: Fields to return. Can be (id, email)
          default: __standard
          examples:
          - id,email
        description: Fields to return. Can be (id, email)
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only id and email in the result
            value: id,email
      responses:
        '200':
          description: List of data
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ScheduleSchemaFields'
                type: array
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    post:
      tags:
      - Schedules
      summary: Create schedule
      operationId: CreateSchedule
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchedulePostRequestSchema'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseJobSchema'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '200':
          description: Schedule data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleSchemaFields'
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id}:
    get:
      tags:
      - Schedules
      summary: Get schedule data
      description: Get requested schedule data
      operationId: GetSchedule
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: schedule_id
        in: path
        schema:
          type: integer
          exclusiveMinimum: 0.0
          title: Schedule ID
          description: Id of the schedule
          examples:
          - 4
        description: Id of the schedule
        required: true
        deprecated: false
        examples:
          schedule_id-example-1:
            summary: Sample schedule ID
            value: 4
      - name: fields
        in: query
        schema:
          type: string
          title: Fields
          description: Fields to return. Can be (id, email)
          default: __standard
          examples:
          - id,email
        description: Fields to return. Can be (id, email)
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only id and email in the result
            value: id,email
      responses:
        '200':
          description: Schedule data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleSchemaFields'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    delete:
      tags:
      - Schedules
      summary: Delete schedule data
      operationId: DeleteSchedule
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: schedule_id
        in: path
        schema:
          type: integer
          exclusiveMinimum: 0.0
          title: Schedule ID
          description: Id of the schedule
          examples:
          - 4
        description: Id of the schedule
        required: true
        deprecated: false
        examples:
          schedule_id-example-1:
            summary: Sample schedule ID
            value: 4
      - name: force
        in: query
        schema:
          type: boolean
          title: Force
          description: Is force delete
          default: false
          examples:
          - false
        description: Is force delete
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          force-example-1:
            summary: Sample force value
            value: false
      responses:
        '204':
          description: Request fulfilled, nothing follows
          headers: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    patch:
      tags:
      - Schedules
      summary: Patch schedule related data
      operationId: PatchSchedule
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: schedule_id
        in: path
        schema:
          type: integer
          exclusiveMinimum: 0.0
          title: Schedule ID
          description: Id of the schedule
          examples:
          - 4
        description: Id of the schedule
        required: true
        deprecated: false
        examples:
          schedule_id-example-1:
            summary: Sample schedule ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchedulePatchRequest'
        required: true
      responses:
        '200':
          description: Schedule data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleSchemaFields'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    WorkItemSchema:
      properties:
        name:
          oneOf:
          - type: string
          - type: 'null'
          title: name
          description: name
          examples:
          - summary: Sample name
            value: pull_cloud_data
        execution_params:
          oneOf:
          - type: object
          - type: 'null'
          title: execution_params
          description: execution_params
          examples:
          - summary: Sample execution_params
            value:
              schedule_type: moment
              first_pull_at: now
              on_refresh_action: replace
        args:
          oneOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: args
          description: args
          examples:
          - summary: Sample args
            value:
            - 123
            - 2586
      type: object
      required: []
      title: WorkItemSchema
    ScheduleSchemaFields:
      properties:
        id:
          oneOf:
          - type: integer
          - type: 'null'
          title: id
          description: id
          examples:
          - summary: '1'
            value: 1
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: created_at
          description: created_at
          examples:
          - summary: Sample created_at
            value: '2020-11-07 10:46:46.094451Z'
        last_run:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: last_run
          description: last_run
          examples:
          - summary: Sample last_run
            value: '2020-08-07 10:46:46.094451Z'
        status:
          oneOf:
          - type: string
          - type: 'null'
          title: status
          description: status
          examples:
          - summary: Sample status
            value: idle
        task_name:
          oneOf:
          - type: string
          - type: 'null'
          title: task_name
          description: task_name
          examples:
          - summary: Sample task_name
            value: pull_cloud_data
        attached_resources:
          oneOf:
          - type: array
          - type: 'null'
          title: attached_resources
          description: attached_resources
          examples:
          - summary: Sample attached_resources
            value:
            - id: 2
              type: dataset
        rrule:
          oneOf:
          - $ref: '#/components/schemas/RecurrenceScheduleFields'
          - type: 'null'
      type: object
      required: []
      title: ScheduleSchemaFields
    SchedulePatchSchema:
      properties:
        rrule:
          oneOf:
          - $ref: '#/components/schemas/RruleSchema'
          - type: 'null'
        work_items:
          oneOf:
          - items:
              $ref: '#/components/schemas/WorkItemSchema'
            type: array
          - type: 'null'
      type: object
      required: []
      title: SchedulePatchSchema
    RruleSchema:
      properties:
        interval:
          type: integer
          title: interval
          description: interval
          examples:
          - summary: Sample rrule interval
            value: 5
        frequency:
          type: string
          enum:
          - minutely
          - hourly
          - daily
          - weekly
          - monthly
          - yearly
          title: frequency
          description: frequency
          examples:
          - summary: Sample rrule frequency
            value: minutely
        start:
          type: string
          format: date-time
          title: start
          description: start
          examples:
          - summary: Sample rrule start time
            value: '2024-05-30 06:27:52'
        by_week_day:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: by_week_day
          description: by_week_day
          examples:
          - summary: Sample by_week_day
            value:
            - MO
        by_month_day:
          oneOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: by_month_day
          description: by_month_day
          examples:
          - summary: Sample by_month_day
            value:
            - 4
      type: object
      required:
      - frequency
      - interval
      - start
      title: RruleSchema
    SchedulePatchData:
      properties:
        op:
          type: string
          enum:
          - replace
          - add
          - remove
          title: op
          description: op
          examples:
          - summary: Sample op
            value: replace
        path:
          type: string
          enum:
          - rrule
          - task
          - args
          - status
          title: path
          description: path
          examples:
          - summary: Sample path
            value: schedule
        value:
          oneOf:
          - $ref: '#/components/schemas/SchedulePatchSchema'
          - type: string
            enum:
            - pause
            - resume
          - type: 'null'
      type: object
      required:
      - op
      - path
      title: SchedulePatchData
    RecurrenceScheduleFields:
      properties:
        start:
          type: string
          format: date-time
          title: start
          description: start time of the schedule
          examples:
          - summary: Sample start time
            value: '2020-08-06 10:56:20Z'
        frequency:
          oneOf:
          - type: string
          - type: 'null'
          title: frequency
          description: frequency
          examples:
          - summary: Sample frequency
            value: yearly
        interval:
          oneOf:
          - type: integer
          - type: 'null'
          title: interval
          description: interval
          examples:
          - summary: Sample interval
            value: 1
        until:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: until
          description: until
          examples:
          - summary: Sample until time
            value: '2025-08-06 10:56:20Z'
        count:
          oneOf:
          - type: integer
          - type: 'null'
          title: count
          description: count
          examples:
          - summary: Sample count
            value: 3
        by_week_day:
          oneOf:
          - type: array
          - type: 'null'
          title: By week day
          description: By week day
          examples:
          - summary: Sample week day
            value:
            - MO
        by_month_day:
          oneOf:
          - type: array
          - type: 'null'
          title: By month day
          description: By month day
          examples:
          - summary: Sample month day
            value:
            - 5
        last_checked_occurrence:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last checked occurrence
          description: Last checked occurrence
          examples:
          - summary: Sample last_checked_occurrence
            value: '2020-08-07 11:46:46.094451Z'
        next_occurrence:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Next occurrence
          description: Next occurrence
          examples:
          - summary: Sample next_occurrence
            value: '2020-08-07 12:46:46.094451Z'
      type: object
      required:
      - start
      title: RecurrenceScheduleFields
    SchedulePostRequestSchema:
      properties:
        rrule:
          $ref: '#/components/schemas/RruleSchema'
        work_items:
          oneOf:
          - items:
              $ref: '#/components/schemas/WorkItemSchema'
            type: array
          - type: 'null'
      type: object
      required:
      - rrule
      title: SchedulePostRequestSchema
      description: Details of a schedule to be created
      examples:
      - rrule:
          interval: 5
          frequency: minutely
          start: '2026-10-30T06:22:01.466762'
          by_month_day: []
          by_week_day: []
        work_items:
        - name: pull_cloud_data
          execution_params:
            schedule_type: moment
            first_pull_at: now
            on_refresh_action: replace
          args:
          - 2586
      - rrule:
          interval: 5
          frequency: minutely
          start: '2026-10-30T06:22:01.466770'
          by_month_day: []
          by_week_day: []
      - rrule:
          interval: 5
          frequency: minutely
          start: '2026-10-30T06:22:01.466775'
          by_month_day: []
          by_week_day: []
        work_items:
        - name: pull_cloud_data
        - task_name: rerun_dataviwes
      - rrule:
          interval: 5
          frequency: minutely
          start: '2024-05-30 06:27:52'
          by_month_day: []
          by_week_day: []
        work_items:
        - name: pull_cloud_data
          execution_params:
            schedule_type: moment
            first_pull_at: now
            on_refresh_action: replace
          args:
          - 123
          - 2586
        - task_name: rerun_dataviwe
          execution_params:
            first_rerun_at: now
            skip_actions: true
          args:
          - 123
          - 2586
    SchedulePatchRequest:
      properties:
        patch:
          items:
            $ref: '#/components/schemas/SchedulePatchData'
          type: array
      type: object
      required:
      - patch
      title: SchedulePatchRequest
      description: Details of a schedule to be updated
      examples:
      - patch:
        - op: replace
          path: rrule
          value:
            rrule:
              interval: 1
              frequency: daily
              start: '2026-10-30T06:22:01.466621'
              by_month_day: []
              by_week_day: []
            work_items:
            - name: pull_cloud_data
              execution_params:
                schedule_type: moment
                first_pull_at: now
                on_refresh_action: replace
        - op: add
          path: task
          value:
            work_items:
            - name: pull_cloud_data
              execution_params:
                schedule_type: moment
                first_pull_at: now
                on_refresh_action: replace
        - op: replace
          path: status
          value: IDLE
    ResponseJobSchema:
      properties:
        id:
          type: integer
        status:
          type: string
          enum:
          - success
          - failure
          - processing
        response:
          type: object
        last_updated_at:
          type: string
          format: date-time
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        path:
          oneOf:
          - type: string
          - type: 'null'
        operation:
          oneOf:
          - type: string
          - type: 'null'
      type: object
      required:
      - id
      - last_updated_at
      - response
      - status
      title: ResponseJobSchema
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json