Skip to main content
GET
get_catalog

Authorizations

Authorization
string
header
required

Send Authorization: Bearer qk_… using an API key created in the Quoin Developer Portal.

Query Parameters

facet
enum<string>
required
Available options:
jurisdictions,
authorities,
coverage,
dictionary,
capabilities,
sources
area_uid
string

Filter jurisdictions or coverage; unsupported on other facets.

Required string length: 1 - 128
subject_kind
string

Coverage domain_key or dictionary entity_name; unsupported on other facets.

Required string length: 1 - 256
record_family
string

Coverage property_class or dictionary data_type; unsupported on other facets.

Required string length: 1 - 256
field_key
string

Dictionary field_key; unsupported on other facets.

Required string length: 1 - 256
limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string
Required string length: 1 - 4096

Response

Canonical response envelope.

contract_version
string
required
Allowed value: "quoin-v2"
request_id
string
required
Required string length: 1 - 512
operation
string
required
Required string length: 1 - 256
status
enum<string>
required
Available options:
ok,
partial,
error
data
object | null
required
error
object | null
required
meta
object
required
provenance
object | null