Skip to main content
GET
Search Cases

Authorizations

Authorization
string
header
required

Casebyte API key, prefixed with cb_live_. Generate one from your casebyte.ai dashboard.

Query Parameters

q
string
required

Search query. Supports plain words, "phrases", and AND/OR/NOT booleans.

Minimum string length: 1
scope
enum<string>
default:all

Which fields to search.

Available options:
all,
case_name,
judgment
court
string

Comma-separated list of HK court codes to filter by (e.g. HKCFA,HKCA). Case-insensitive on input. Unknown codes return 400 invalid_court.

Pattern: ^(HKCFA|HKCA|HKCFI|HKDC|HKMAGC|HKFC|HKLDT|HKLAT|HKSCT|HKOAT|HKCT|HKCRC)(,(HKCFA|HKCA|HKCFI|HKDC|HKMAGC|HKFC|HKLDT|HKLAT|HKSCT|HKOAT|HKCT|HKCRC))*$
start
string<date>

Inclusive lower bound for publish_date. Must be YYYY-MM-DD.

end
string<date>

Inclusive upper bound for publish_date. Must be YYYY-MM-DD. Must be on or after start.

order
enum<string>
default:desc

Sort order for publish_date.

Available options:
asc,
desc
limit
integer
default:20

Page size.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of results to skip. offset + limit must be ≤ 10,000.

Required range: 0 <= x <= 10000

Response

Search results.

total
integer
required

Total number of cases matching the query (the corpus-wide count, not the page size).

limit
integer
required

Echo of the limit parameter actually applied.

offset
integer
required

Echo of the offset parameter actually applied.

results
object[]
required