---
title: "Retrieve the validation schema for a roster job"
method: GET
path: "/roster/{id}/schema"
tags: ["Roster"]
---

# Retrieve the validation schema for a roster job

`GET /roster/{id}/schema`

Returns the JSON Schema document that governs validation of the rows in one roster job.

**When to use:** call this before preparing or correcting a roster file, to see exactly which fields, types, and constraints will be enforced; it is also the quickest way to understand why particular rows failed validation.

**How the schema is resolved:** a schema attached to this specific roster job takes precedence; when the job has none, the schema belonging to its template is returned instead.

**Preconditions:** supply the `tenant-id` header and the roster job's `id`. The job must have a template associated with it - a roster without one returns 400, which is resolved by assigning a valid template to the roster and calling again.

**What you get back:** a JSON Schema document conforming to draft 2019-09, describing the expected shape of a single roster row. Read-only; no state is mutated.

## Path parameters

- `id` string, required

## Headers

- `tenant-id` string, required

## Response `200`

The JSON Schema document that roster rows are validated against.

- object — A JSON Schema document (draft 2019-09). Free-form here because its properties mirror the roster's template, so the keys vary per roster.

## Other responses

- `400` — Returned when the roster job has no template associated with it, so no schema can be resolved. Assign a valid template to the roster and retry.
- `401` — Returned when the request carries no valid authentication.
- `403` — Returned when the caller lacks the READ_ROSTER permission for this tenant.
- `404` — Returned when no roster job with the supplied `id` exists for the tenant.

---

[API](https://skmtc.net/certifyos/apis/certify-api-layer.md) · [All operations](https://skmtc.net/certifyos/apis/certify-api-layer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/certifyos/certify-api-layer/revisions/563848e0ecc0/schema)