/payscale/jobs/reviews

POST /api/payscale/jobs/reviews

Price: 1 credit

Get user-written reviews for a job title: each review has the reviewer's role and location, the question prompt, a headline, the pros and cons, the employer and when it was last updated.

How to use it

Fetch Payscale reviews for a job title or slug. Set country (US/CA/UK/AU) and count. Each item has question_id, user_description, question_prompt, title, text, pros, cons, employer, job_title, country, city, question_type and updated_at.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — Job title or Payscale job slug (examples: "Software Engineer", "Registered_Nurse_(RN)"; minLength: 1)
• country string — Country of the reviews (default: "US"; one of: "US", "CA", "UK", "AU")
• count integer required — Max number of reviews to return (min: 1)

Response

• @type string (default: "PayscaleReview")
• question_id integer nullable
• user_description string nullable
• question_prompt string nullable
• text string nullable
• pros string nullable
• cons string nullable
• employer string nullable
• job_title string nullable
• country string nullable
• city string nullable
• question_type integer nullable
• updated_at string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Job not found (well-formed but nonexistent job slug) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.