---
updatedAt: 2026-06-12T21:21:07.000Z
agentTools:
  projectIndex: https://cloud.docs.tamr.com/llms.txt
---

# get

Fetch details of a Schedule.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Schedules",
    "version": "v1beta1"
  },
  "tags": [
    {
      "name": "tamr.api.schedules.v1beta1.Schedules"
    }
  ],
  "paths": {
    "/api/v1beta1/schedules/{scheduleId}": {
      "get": {
        "summary": "get",
        "description": "Fetch details of a Schedule.",
        "operationId": "Schedules_GetSchedule",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tamr.api.schedules.v1beta1.Schedule"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "scheduleId",
            "description": "Required. The ID of the schedule to retrieve.",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "tags": [
          "tamr.api.schedules.v1beta1.Schedules"
        ]
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "X-API-KEY",
        "value": "example-api-key"
      }
    ]
  },
  "servers": [
    {
      "url": "https://api-examples.tamr.cloud"
    }
  ],
  "components": {
    "schemas": {
      "tamr.api.schedules.v1beta1.Crontab": {
        "type": "object",
        "properties": {
          "minute": {
            "type": "string",
            "description": "Minute of the hour when events should occur (0-59, *, */2, etc.). Default is *."
          },
          "hour": {
            "type": "string",
            "description": "Hour of the day when events should occur (0-23, *, */2, etc.). Default is *."
          },
          "day": {
            "type": "string",
            "description": "Day of the month when events should occur (1-31, *, */2, etc.). Default is *."
          },
          "month": {
            "type": "string",
            "description": "Month of the year when events should occur (1-12, *, */2, JAN-DEC, etc.). Default is *."
          },
          "weekDay": {
            "type": "string",
            "description": "Day of the week when events should occur (0-7, *, SUN-SAT, etc.). Both 0 and 7 represent Sunday.  Default is *."
          }
        },
        "description": "Represents a recurring timetable for scheduling events, following Unix-style crontab format. Valid values are as\nfollows:\n- Minute: 0-59\n- Hour: 0-23\n- Day: 1-31\n- Month: 1-12 or JAN-DEC\n- Week day: 0-7 (0 and 7 are both Sunday) or SUN-SAT\nIn addition, it's allowed to match multiple values, as follows:\n- Match all values: *\n- Match a range of values: 1-5\n- Match a range of values with step: */2\n- Match a list of values: 1,2,3 (comma separated, no spaces)\nNote: The minimum allowed interval between any two events is 60 minutes.",
        "required": [
          "minute",
          "hour",
          "day",
          "month",
          "weekDay"
        ]
      },
      "tamr.api.schedules.v1beta1.Schedule": {
        "type": "object",
        "properties": {
          "scheduleId": {
            "type": "string",
            "description": "Unique ID of the schedule, generated by the service on creation."
          },
          "displayName": {
            "type": "string",
            "description": "Required. Display name of the Schedule, defined by the user."
          },
          "description": {
            "type": "string",
            "description": "Optional. Description of the Schedule, defined by the user."
          },
          "createTime": {
            "type": "string",
            "format": "date-time",
            "description": "Output only. Time when the Schedule was created.",
            "readOnly": true
          },
          "updateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Output only. Time when the Schedule was last updated.",
            "readOnly": true
          },
          "timetable": {
            "description": "Required. Describes the actual schedule of events.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.schedules.v1beta1.ScheduleTimetable"
              }
            ]
          },
          "action": {
            "description": "Required. Describes the action to perform when the Schedule's events occur.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.schedules.v1beta1.ScheduleAction"
              }
            ]
          },
          "state": {
            "description": "Optional. Whether the schedule is active or paused. While paused, scheduled events are skipped, but can still be\nforced to occur with RunSchedule. Default is active.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.schedules.v1beta1.ScheduleState"
              }
            ]
          },
          "latestEvent": {
            "description": "Output only. Provides information about the timing and status of the most recent scheduled event.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.schedules.v1beta1.ScheduleEvent"
              }
            ]
          }
        },
        "description": "Represents an action to perform on a recurring schedule.",
        "required": [
          "displayName",
          "timetable",
          "action"
        ]
      },
      "tamr.api.schedules.v1beta1.ScheduleAction": {
        "type": "object",
        "properties": {
          "userEmail": {
            "type": "string",
            "description": "Output only. The user who performs the action. This is the user who created or last updated the Schedule.",
            "readOnly": true
          },
          "job": {
            "description": "Indicates the action is to run a Job with the given configuration.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.v1beta1.JobConfiguration"
              }
            ]
          }
        },
        "description": "Describes the action to perform when a scheduled event occurs."
      },
      "tamr.api.schedules.v1beta1.ScheduleActionMetadata": {
        "type": "object",
        "properties": {
          "actionId": {
            "type": "string",
            "description": "A unique reference identifier for the occurrence of the action.",
            "readOnly": true
          },
          "job": {
            "description": "If the action was to create a job, this field will be set and will describe the latest state of the job. Note\nthat this field may not be set while the job is queued and pending launch. A job may remain queued for some time\nif resources are not yet available to run it, for example, because the maximum number of concurrent jobs has been\nreached.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.v1beta1.Job"
              }
            ]
          }
        },
        "description": "Details about what happened to a scheduled action, for example, its progress and status information."
      },
      "tamr.api.schedules.v1beta1.ScheduleEvent": {
        "type": "object",
        "properties": {
          "scheduleId": {
            "type": "string",
            "description": "The ID of the schedule that produced this event.",
            "readOnly": true
          },
          "eventTime": {
            "type": "string",
            "format": "date-time",
            "description": "The time the scheduled event took place, as an RFC 3339 timestamp.",
            "readOnly": true
          },
          "state": {
            "description": "State of the scheduled event.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.schedules.v1beta1.ScheduleEvent.State"
              }
            ]
          },
          "error": {
            "description": "Describes the cause of failure if this event is rejected, otherwise empty.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.v1beta1.Error"
              }
            ]
          },
          "metadata": {
            "description": "Describes what happened (or is happening) with the scheduled action, for example, its progress and status\ninformation. This field is only set if the event is accepted.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.schedules.v1beta1.ScheduleActionMetadata"
              }
            ]
          }
        },
        "description": "Describes what happened when a scheduled event took place."
      },
      "tamr.api.schedules.v1beta1.ScheduleEvent.State": {
        "type": "string",
        "example": "RUNNING",
        "enum": [
          "REJECTED",
          "ACCEPTED",
          "SKIPPED"
        ],
        "default": "REJECTED",
        "description": "State of the scheduled event.\n\n - REJECTED: The event was rejected because of an error launching the action. Rejected events are retried automatically.\nCheck the `error` field for more details.\n - ACCEPTED: The event was accepted and the scheduled action launched. Check the `metadata` field for more details about the\naction itself.\n - SKIPPED: The event was skipped and the scheduled action did not take place, because the Schedule was paused."
      },
      "tamr.api.schedules.v1beta1.ScheduleState": {
        "type": "string",
        "enum": [
          "SCHEDULE_STATE_ACTIVE",
          "SCHEDULE_STATE_PAUSED"
        ],
        "default": "SCHEDULE_STATE_ACTIVE",
        "description": " - SCHEDULE_STATE_ACTIVE: Scheduled events will occur as normal.\n - SCHEDULE_STATE_PAUSED: Scheduled events will not occur until the schedule is resumed. Events can still be forced to run on-demand using\nRunSchedule with force=true."
      },
      "tamr.api.schedules.v1beta1.ScheduleTimetable": {
        "type": "object",
        "properties": {
          "timeZone": {
            "type": "string",
            "description": "The time zone to use to evaluate the timetable. The value must be a valid time zone from the IANA Time Zone\ndatabase. Values are case sensitive."
          },
          "crontab": {
            "description": "Represents a recurring timetable for execution, following Unix-style crontab format. Valid values are as follows:\n- Minute: 0-59\n- Hour: 0-23\n- Day: 1-31\n- Month: 1-12 or JAN-DEC\n- Week day: 0-7 (0 and 7 are both Sunday) or SUN-SAT\nIn addition, it's allowed to match multiple values, as follows:\n- Match all values: *\n- Match a range of values: 1-5\n- Match a range of values with step: */2\n- Match a list of values: 1,2,3 (comma separated, no spaces)\nNote: The minimum allowed interval between any two runs is 30 minutes.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.schedules.v1beta1.Crontab"
              }
            ]
          },
          "nextEventTime": {
            "type": "string",
            "format": "date-time",
            "description": "The time of the next scheduled event, or empty if the schedule is paused. Note that the next event may be either\na regularly scheduled one or a retry of a rejected one.",
            "readOnly": true
          }
        },
        "description": "Describes the actual schedule of events.",
        "required": [
          "timeZone",
          "crontab"
        ]
      },
      "tamr.api.v1beta1.Error": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "description": "A short error code that summarizes the error. This is a constant value that identifies the cause of the error.\nThis should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents\nUPPER_SNAKE_CASE.",
            "readOnly": true
          },
          "message": {
            "type": "string",
            "description": "A human-readable description of the error. Error messages should be concise and helpful, providing specifics about\nthe problem when appropriate and suggesting next steps to resolve. Error messages should not expose sensitive\ninformation about system internals.",
            "readOnly": true
          }
        }
      },
      "tamr.api.v1beta1.Job": {
        "type": "object",
        "properties": {
          "jobId": {
            "type": "string",
            "description": "Output only. ID of the job.",
            "readOnly": true
          },
          "configuration": {
            "description": "Required. What the job does.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.v1beta1.JobConfiguration"
              }
            ]
          },
          "status": {
            "description": "Output only. Current status of the job.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.v1beta1.JobStatus"
              }
            ]
          },
          "statusHistory": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/tamr.api.v1beta1.JobStatus"
            },
            "description": "Output only. Past statuses of the job.",
            "readOnly": true
          }
        },
        "description": "Describes configuration and status of a job.",
        "required": [
          "configuration"
        ]
      },
      "tamr.api.v1beta1.JobConfiguration": {
        "type": "object",
        "properties": {
          "load": {
            "$ref": "#/components/schemas/tamr.api.v1beta1.JobConfiguration.LoadJob"
          },
          "update": {
            "$ref": "#/components/schemas/tamr.api.v1beta1.JobConfiguration.UpdateJob"
          },
          "publish": {
            "$ref": "#/components/schemas/tamr.api.v1beta1.JobConfiguration.PublishJob"
          }
        },
        "description": "Required. Set only one type. What the job does."
      },
      "tamr.api.v1beta1.JobConfiguration.LoadJob": {
        "type": "object",
        "properties": {
          "sourceId": {
            "type": "string",
            "description": "Required. Source to load."
          }
        },
        "description": "Load source data.",
        "required": [
          "sourceId"
        ]
      },
      "tamr.api.v1beta1.JobConfiguration.PublishJob": {
        "type": "object",
        "properties": {
          "destinationId": {
            "type": "string",
            "description": "Required. Destination to refresh."
          },
          "dataProductId": {
            "type": "string",
            "description": "Optional for legacy Data Products only. Data product to publish."
          }
        },
        "description": "[Pick one] Publish data to a destination.",
        "required": [
          "destinationId"
        ]
      },
      "tamr.api.v1beta1.JobConfiguration.UpdateJob": {
        "type": "object",
        "properties": {
          "dataProductId": {
            "type": "string",
            "description": "Data product to update."
          },
          "workflowId": {
            "type": "string",
            "description": "Workflow to run."
          }
        },
        "description": "[Pick one] Run a data product flow to update results or a workflow to update a system of records."
      },
      "tamr.api.v1beta1.JobState": {
        "type": "string",
        "example": "RUNNING",
        "enum": [
          "STATE_UNSPECIFIED",
          "PENDING",
          "RUNNING",
          "STOPPING",
          "DONE"
        ],
        "default": "STATE_UNSPECIFIED",
        "description": "Represents the lifecycle of a job.\n\n - STATE_UNSPECIFIED: Default value. The job state value is unset. This value should not be used.\n - PENDING: The job has been received but has not begun to execute.\n - RUNNING: The job is actively executing.\n - STOPPING: A signal to stop has been received, but the job is still running.\n - DONE: The job is done."
      },
      "tamr.api.v1beta1.JobStatus": {
        "type": "object",
        "properties": {
          "state": {
            "description": "Output only. State of job execution.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.v1beta1.JobState"
              }
            ]
          },
          "stateStartTime": {
            "type": "string",
            "format": "date-time",
            "description": "Output only. Time when the job entered this state.",
            "readOnly": true
          },
          "error": {
            "description": "Optional. Output only. If present, indicates that the job is done and was unsuccessful.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.v1beta1.Error"
              }
            ]
          }
        },
        "description": "Output only. Describes execution status and errors.",
        "readOnly": true
      }
    }
  }
}
```