---
title: "Get a schedule"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Workflows API

`GET /v1/organizations/{orgId}/projects/{projectId}/schedules/{scheduleId}`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `GetSchedule.path.orgId` (string, required)
  - format `uuid`
- `GetSchedule.path.projectId` (string, required)
  - format `uuid`
- `GetSchedule.path.scheduleId` (string, required)
  - format `uuid`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08"

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

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

print(response.text)
```

## Responses

### 200

The schedule. ETag is its revision.

#### Example

```json
{
  "activeRunId": "134a5a0d-d6db-48c7-a90c-9d6689bf18d5",
  "appId": "28c365d5-df94-4a54-8217-3ce51d068868",
  "catchupWindowSeconds": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "cron": "string",
  "hasInput": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "jitterSeconds": 0,
  "lastScheduledTime": "2019-08-24T14:15:22Z",
  "missed": 0,
  "name": "string",
  "nextFireAt": "2019-08-24T14:15:22Z",
  "nextScheduledTime": "2019-08-24T14:15:22Z",
  "overlap": "skip",
  "paused": true,
  "pausedBy": "customer",
  "resourceName": "string",
  "revision": 0,
  "skipped": 0,
  "timeZone": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflow": "string"
}
```

- `GetSchedule.response.200.activeRunId` (string | null, required)
  - format `uuid`
- `GetSchedule.response.200.appId` (string, required)
  - format `uuid`
- `GetSchedule.response.200.catchupWindowSeconds` (integer, required)
- `GetSchedule.response.200.createdAt` (string, required)
  - format `date-time`
- `GetSchedule.response.200.cron` (string, required) — 5 fields (minute hour day-of-month month day-of-week), or @hourly, @daily, @weekly, @monthly, @yearly.
- `GetSchedule.response.200.hasInput` (boolean, required)
- `GetSchedule.response.200.id` (string, required)
  - format `uuid`
- `GetSchedule.response.200.jitterSeconds` (integer, required)
- `GetSchedule.response.200.lastScheduledTime` (string | null, required)
  - format `date-time`
- `GetSchedule.response.200.missed` (integer, required) — Firings missed beyond the catch-up window.
- `GetSchedule.response.200.name` (string, required)
- `GetSchedule.response.200.nextFireAt` (string | null, required)
  - format `date-time`
- `GetSchedule.response.200.nextScheduledTime` (string | null, required)
  - format `date-time`
- `GetSchedule.response.200.overlap` (string, required)
  - one of `"skip"`, `"allow"`, `"bufferOne"`
- `GetSchedule.response.200.paused` (boolean, required)
- `GetSchedule.response.200.pausedBy` (string | null, required) — Who holds the schedule paused: customer (POST …/pause), system (the platform, while the organization's deletion is pending; it fires again if the deletion is cancelled), or null when it fires.
  - one of `"customer"`, `"system"`, `null`
- `GetSchedule.response.200.resourceName` (string, required)
- `GetSchedule.response.200.revision` (integer, required) — Changes with every create, update, pause, resume and delete; If-Match compares it. Firings don't change it.
- `GetSchedule.response.200.skipped` (integer, required) — Firings skipped by the overlap policy.
- `GetSchedule.response.200.timeZone` (string, required) — An IANA time zone.
- `GetSchedule.response.200.updatedAt` (string, required)
  - format `date-time`
- `GetSchedule.response.200.workflow` (string, required)

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSchedule.response.400.error` (object, required)
  - `GetSchedule.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSchedule.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetSchedule.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSchedule.response.400.error.issues.message` (string, required)
    - `GetSchedule.response.400.error.issues.path` (string, required)
  - `GetSchedule.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSchedule.response.400.error.quota.id` (string, required)
    - `GetSchedule.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSchedule.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetSchedule.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSchedule.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSchedule.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSchedule.response.400.error.quota.region` (string, optional)
    - `GetSchedule.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSchedule.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetSchedule.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetSchedule.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSchedule.response.401.error` (object, required)
  - `GetSchedule.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSchedule.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetSchedule.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSchedule.response.401.error.issues.message` (string, required)
    - `GetSchedule.response.401.error.issues.path` (string, required)
  - `GetSchedule.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSchedule.response.401.error.quota.id` (string, required)
    - `GetSchedule.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSchedule.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetSchedule.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSchedule.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSchedule.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSchedule.response.401.error.quota.region` (string, optional)
    - `GetSchedule.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSchedule.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetSchedule.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetSchedule.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSchedule.response.403.error` (object, required)
  - `GetSchedule.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSchedule.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetSchedule.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSchedule.response.403.error.issues.message` (string, required)
    - `GetSchedule.response.403.error.issues.path` (string, required)
  - `GetSchedule.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSchedule.response.403.error.quota.id` (string, required)
    - `GetSchedule.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSchedule.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetSchedule.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSchedule.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSchedule.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSchedule.response.403.error.quota.region` (string, optional)
    - `GetSchedule.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSchedule.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetSchedule.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetSchedule.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSchedule.response.404.error` (object, required)
  - `GetSchedule.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSchedule.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetSchedule.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSchedule.response.404.error.issues.message` (string, required)
    - `GetSchedule.response.404.error.issues.path` (string, required)
  - `GetSchedule.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSchedule.response.404.error.quota.id` (string, required)
    - `GetSchedule.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSchedule.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetSchedule.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSchedule.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSchedule.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSchedule.response.404.error.quota.region` (string, optional)
    - `GetSchedule.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSchedule.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetSchedule.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetSchedule.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSchedule.response.429.error` (object, required)
  - `GetSchedule.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSchedule.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetSchedule.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSchedule.response.429.error.issues.message` (string, required)
    - `GetSchedule.response.429.error.issues.path` (string, required)
  - `GetSchedule.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSchedule.response.429.error.quota.id` (string, required)
    - `GetSchedule.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSchedule.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetSchedule.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSchedule.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSchedule.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSchedule.response.429.error.quota.region` (string, optional)
    - `GetSchedule.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSchedule.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetSchedule.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetSchedule.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSchedule.response.500.error` (object, required)
  - `GetSchedule.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSchedule.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetSchedule.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSchedule.response.500.error.issues.message` (string, required)
    - `GetSchedule.response.500.error.issues.path` (string, required)
  - `GetSchedule.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSchedule.response.500.error.quota.id` (string, required)
    - `GetSchedule.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSchedule.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetSchedule.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSchedule.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSchedule.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSchedule.response.500.error.quota.region` (string, optional)
    - `GetSchedule.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSchedule.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetSchedule.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetSchedule.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSchedule.response.503.error` (object, required)
  - `GetSchedule.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSchedule.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetSchedule.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSchedule.response.503.error.issues.message` (string, required)
    - `GetSchedule.response.503.error.issues.path` (string, required)
  - `GetSchedule.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSchedule.response.503.error.quota.id` (string, required)
    - `GetSchedule.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSchedule.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetSchedule.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSchedule.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSchedule.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSchedule.response.503.error.quota.region` (string, optional)
    - `GetSchedule.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSchedule.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetSchedule.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetSchedule.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/workflows-api/GetSchedule/index.md