> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Pull schedule definition (config-as-code)

GET https://api.runtype.com/v1/schedules/pull

Return the canonical config-as-code definition and provenance for a standalone schedule by name and target — the absorb-drift direction of the ensure protocol. The target is echoed in the form the query used, and the definition always declares `enabled`.

Reference: https://docs.runtype.com/api-reference/runtype-api/schedules/pull-schedule-definition-config-as-code

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Query parameters

- `name` (string, required)
- `flowId` (string, optional)
- `agentId` (string, optional)
- `flowName` (string, optional)
- `agentName` (string, optional)

## Response

### 200

Canonical definition + provenance

- `contentHash` (string, required)
- `definition` (ScheduleEnsureDefinition, required)
- `lastModifiedSource` (string, required, nullable)
- `scheduleId` (string, required)
- `updatedAt` (string, required, nullable)

## Errors

### 400 Bad Request Error

Validation error

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 404 Not Found Error

No schedule with that name on that target in the account scope

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

## Types

### ScheduleEnsureDefinition

- `name` (string, required)
- `target` (ScheduleEnsureTarget, required)
- `trigger` (ScheduleEnsureDefinitionTrigger, required)
- `enabled` (boolean, optional) — Omit to leave the current paused/active state untouched; new schedules start enabled.
- `executionOptions` (ScheduleEnsureDefinitionExecutionOptions, optional)
- `inputs` (map from string to any, optional)
- `messages` (list of map from string to any, optional)
- `recordFilter` (map from string to any, optional)
- `recordIds` (list of string, optional)
- `recordType` (string, optional)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### ScheduleEnsureTarget

- `agentId` (string, optional)
- `agentName` (string, optional)
- `flowId` (string, optional)
- `flowName` (string, optional)

### ScheduleEnsureDefinitionTrigger

- `type` (enum, required)
  - Allowed values: `recurring`, `one_time`
- `cron` (string, optional)
- `runAt` (datetime, optional)
- `timezone` (string, optional)

### ScheduleEnsureDefinitionExecutionOptions

- `chunkSize` (integer, optional)
- `flowTimeoutMs` (integer, optional)
- `loggingPolicy` (enum, optional)
  - Allowed values: `default`, `on`, `off`
- `maxRetries` (integer, optional)
- `modelOverride` (string, optional)
- `progressFlushSize` (integer, optional)
- `recordConcurrency` (integer, optional)
- `skipCacheWarm` (boolean, optional)
- `stepTimeoutMs` (integer, optional)
- `timeoutMs` (integer, optional)

## Examples

**Response**

```json
{
  "contentHash": "string",
  "definition": {
    "name": "string",
    "target": {
      "agentId": "string",
      "agentName": "string",
      "flowId": "string",
      "flowName": "string"
    },
    "trigger": {
      "type": "recurring",
      "cron": "string",
      "runAt": "2024-01-15T09:30:00Z",
      "timezone": "string"
    },
    "enabled": true,
    "executionOptions": {
      "chunkSize": 1,
      "flowTimeoutMs": 1,
      "loggingPolicy": "default",
      "maxRetries": 1,
      "modelOverride": "string",
      "progressFlushSize": 1,
      "recordConcurrency": 1,
      "skipCacheWarm": true,
      "stepTimeoutMs": 1,
      "timeoutMs": 1
    },
    "inputs": {},
    "messages": [
      {}
    ],
    "recordFilter": {},
    "recordIds": [
      "string"
    ],
    "recordType": "string"
  },
  "lastModifiedSource": "string",
  "scheduleId": "string",
  "updatedAt": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/schedules/pull"

querystring = {"name":"name"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/schedules/pull?name=name';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/schedules/pull?name=name"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/schedules/pull?name=name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.runtype.com/v1/schedules/pull?name=name")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.runtype.com/v1/schedules/pull?name=name', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/schedules/pull?name=name");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/schedules/pull?name=name")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```