---
title: "getRateJobs"
method: GET
path: "/getRateJobs"
tags: ["Rate"]
---

# getRateJobs

`GET /getRateJobs`

Returns a list of Rate Jobs. Rate jobs are only returned within 7 days of creation, after 7 days they will not be returned in the response. Requests which do not provide a jobReferenceID will be filtered by the client ID of the request's token.

## Query parameters

- `jobReferenceID` string
- `status` string

## Response `200`

200 Response

- GetRateJobsResponse
  - `success` boolean — Returns if the request could be completed
  - `hasNextPage` boolean — Returns true if there is another page of results after this one
  - `nextPage` string, nullable — The URL of the next page of results if there is one
  - `data` object[] — Job details
    - `jobReferenceID` string — Reference ID for the job created for this update. This can be used to track success of the batch for this rate update. See getRateJobs or the rate:batch_job
    - `dateCreated` string, date — Rate Job creation datetime
    - `status` string — Status of the Rate Job. in_progress - job is processing. completed - job has completed successfully. error - there was an error with 1 or more updates requested in this job. Allowed values: in_progressgu, completed, error
    - `updates` object[] — Array of actions produced from this job
      - `rateID` string — Rate ID for which action was taken
      - `action` string — Action taken for this interval as part of this job. in_progress - interval wait for it turn. updated - interval was updated. created - new interval was created with the new date range. error - there was an error when attempting this update. Allowed values: in_progress, updated, created, error
      - `startDate` string, date — Interval start date
      - `endDate` string, date — Interval end date
      - `rate` number — Value of rate which was updated
      - `maxLos` integer, nullable — Maximum length of stay for this rate
      - `minLos` integer, nullable — Minimum length of stay for this rate
      - `closedToArrival` boolean, nullable — If this rate is closed to arrival
      - `closedToDeparture` boolean, nullable — If this rate is closed to departure
      - `cutOff` integer, nullable — Cutoff for this rate
      - `lastMinuteBooking` integer, nullable — Last minute booking for this rate
      - `message` string, nullable — Error message

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)