Get a schedule API reference

Request

GEThttps://api.scrapercompany.com/v1/async/schedules/{schedule_id}

Authenticate with your API key in the x-api-key header (see Authentication).

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Parameters

schedule_idstringpathrequired

Example request

curl "https://api.scrapercompany.com/v1/async/schedules/asyncsched_0123456789abcdef0123456789abcdef" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY"

Response

200 — The schedule and its next/last run state.

200 response

{
  "id": "asyncsched_0123456789abcdef0123456789abcdef",
  "name": "nightly-comp-set",
  "enabled": true,
  "cadence": "daily",
  "run_hour": 6,
  "weekday": 0,
  "timezone": "America/New_York",
  "destination_id": "asyncdst_0123456789abcdef0123456789abcdef",
  "next_run_at": "2026-10-23T10:00:00Z",
  "last_run_at": "2026-10-22T10:00:00Z",
  "last_job_id": "asyncjob_0123456789abcdef0123456789abcdef",
  "created_at": "2026-10-20T09:00:00Z",
  "updated_at": "2026-10-22T10:00:01Z",
  "items": [
    {
      "operation": "google_calendar",
      "body": {
        "token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
        "days": 90,
        "currency": "USD",
        "market": "US"
      }
    }
  ],
  "priority": 5,
  "max_credits": 100,
  "meta": {
    "batch": "nightly"
  },
  "include_results": false,
  "items_total": 1
}

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

Status	Meaning	Retry?
`401`Unauthorized	Missing or invalid API key. `{"detail":"missing or invalid API key"}`	No, fix the request
`404`Not Found	The property, stay, job or record was not found. `{"detail":"job not found"}`	No, fix the request
`422`Unprocessable Content	Request validation failed. `{"detail":[{"loc":["body","token"],"msg":"Field required","type":"missing"}]}`	No, fix the request
`429`Too Many Requests	Too many requests: the key's requests-per-minute limit was exceeded, or (in `enforce` credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry. `{"detail":"rate limit 60/min exceeded"}`	Yes, with backoff
`503`Service Unavailable	Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later. `{"detail":"database unavailable: OperationalError"}`	Yes, with backoff

Try it

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
Copy the cURL example above and run it in a terminal.

Request#

Parameters#

Example request#

Response#

Errors#

Try it#