Jobs

Retrieve a job

Retrieve a job

Required scopes: jobs:read

Read-only. Returns bounded linked artifact summaries for existing job_id associations. Missing, malformed, cross-org, and wrong-mode ids return 404 not_found.

Example (curl):

curl https://api.yardstick.team/v1/jobs/job_abc123 \
  -H 'Authorization: Bearer ys_sk_live_…'

Example (TypeScript):

await fetch("https://api.yardstick.team/v1/jobs/job_abc123", {
  headers: { Authorization: `Bearer ${process.env.YS_API_KEY}` },
}).then((r) => r.json());
get/v1/jobs/{job_id}

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/jobs/{job_id}
  • Auth: HTTP bearer

Path parameters

job_idstring required

Headers

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Response

Success

idstring required

Display id, e.g. job_<base32>

object'job' required
status'draft' | 'open' | 'paused' | 'closed' | 'archived' required
titlestring required
departmentstring nullable required

Legacy free-text department metadata. Preserved for backward compatibility. New integrations should use department_id for authoritative ownership; this field is advisory display text only.

department_idstring nullable required

Display ID of the linked Department (internal Group). Use this for authoritative ownership. Null when the Job has no linked Department.

department_namestring nullable required

Live name of the linked Department (Group). Null when the Job has no linked Department.

locationstring nullable required
location_type'remote' | 'hybrid' | 'onsite' nullable required
descriptionstring nullable required
livemodeboolean required
created_atstring nullable required

ISO-8601 UTC

updated_atstring nullable required

ISO-8601 UTC

closed_atstring nullable required

ISO-8601 UTC

archived_atstring nullable required

ISO-8601 UTC

Changes

No recorded changes to this operation across all 1 revision of this API.