# /dhet/programmes/search

`POST /api/dhet/programmes/search`

Price: 20 credits

Search the programmes private higher education institutions in South Africa are registered to offer, by programme name, institution, registration status, province, NQF level, mode of delivery and HEQSF alignment. Each programme carries its NQF level, credits, modes of delivery with their sites and the institution's name, registration number and status.

## How to use it

Use this to find which private institutions in South Africa offer a qualification; registration_number takes the number dhet/institutions/search returns.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `count` (integer, required) — Max number of results (min: 1)
- `name` (string, nullable) — Words of the programme name, ignoring letter case: every word must be contained (examples: "Bachelor of Commerce", "nursing")
- `registration_number` (string, nullable) — Registration number of the institution (examples: "2000/HE07/015")
- `status` (string, nullable) — Registration status of the institution (one of: "registered", "provisionally_registered", "cancellation_pending", "deregistered", "discontinued")
- `province` (string, nullable) — Province of the institution (one of: "Eastern Cape", "Free State", "Gauteng", "KwaZulu-Natal", "Limpopo", "Mpumalanga", "North West", "Northern Cape", "Western Cape"; examples: "Western Cape")
- `nqf_level` (integer, nullable) — NQF level of the programme (min: 1; max: 10)
- `mode` (string, nullable) — Mode of delivery (one of: "contact", "distance", "blended", "hybrid", "mixed", "online", "full_time", "part_time")
- `is_heqsf_aligned` (boolean, nullable) — Whether the register marks the programme HEQSF aligned

## Response

### 200 — Successful Response

- `@type` (string) (default: "DhetProgrammeListing")
- `position` (integer, nullable) — Number of the programme in the institution's list
- `name` (string, nullable) — Qualification name (examples: "Higher Certificate in Digital Marketing")
- `nqf_level` (integer, nullable) — NQF level of the qualification (examples: 5, 7)
- `credits` (integer, nullable) — Credits of the qualification (examples: 120, 360)
- `is_heqsf_aligned` (boolean, nullable) — Whether the register marks the qualification HEQSF aligned
- `delivery` (array) — Modes of delivery with the sites of each (default: [])
  - `@type` (string) (default: "DhetDelivery")
  - `mode` (union, nullable) — Mode of delivery (examples: "contact", "distance")
  - `site_letters` (array) — Letters of the sites where the programme is offered in this mode (default: []; examples: ["A","B"])
- `text` (string, nullable) — The programme entry as the register prints it (examples: "Higher Certificate in Marketing Communication (HEQSF Aligned, NQF Level 5, 120- Credits: Contact Mode) [A, B]")
- `institution_registration_number` (string, nullable) — Registration number of the institution (examples: "2000/HE07/015")
- `institution_name` (string, nullable) — Institution name
- `institution_status` (string, nullable) — Registration status of the institution (one of: "registered", "provisionally_registered", "cancellation_pending", "deregistered", "discontinued"; examples: "registered")
- `province` (union, nullable) — Province of the institution (examples: "Gauteng")
- `sites` (array) — Sites where the programme is offered (default: [])
  - `@type` (string) (default: "DhetSite")
  - `letter` (string, nullable) — Letter the register gives the site; programmes refer to it (examples: "A")
  - `town` (string, nullable) — Town or campus label of the site (examples: "Bryanston")
  - `address` (string, nullable) — Street address of the site (examples: "The Braes Office Park, 3 Eaton Avenue, Bryanston, 2191")
- `register_date` (integer, nullable) — Date of the register edition the record comes from, unix seconds (examples: 1791936000)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

No programme matches these filters

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.

