Regbase API
Reference

Search entities

Parses `q` as GFFS. Field qualifiers are applied as static filters before ranking. Remaining text uses reciprocal-rank fusion of full-text and semantic vector search. A qualifier-only query returns up to 100 matching entities without hybrid ranking. Allowed qualifier fields: type, title, name, displayDate, jurisdiction, localIdentifier, localType, authority, status.

GET
/v1/search

Parses q as GFFS. Field qualifiers are applied as static filters before ranking. Remaining text uses reciprocal-rank fusion of full-text and semantic vector search. A qualifier-only query returns up to 100 matching entities without hybrid ranking. Allowed qualifier fields: type, title, name, displayDate, jurisdiction, localIdentifier, localType, authority, status.

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key. Send Authorization: Bearer rb_live_….

In: header

Query Parameters

q*string

GFFS query. Top-level field qualifiers are applied before ranking; remaining text is ranked with full-text and semantic vector search.

Length1 <= length

Response Body

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

curl -X GET "https://example.com/v1/search?q=string"
{  "data": [    {      "type": "string",      "id": "string",      "attributes": {        "title": "string",        "name": "string",        "displayDate": "string",        "jurisdiction": "string",        "localIdentifier": "string",        "localType": "string",        "authority": "string",        "status": "string",        "texts": [          {            "textId": "string",            "localUrl": "string",            "date": "string",            "mime": "string",            "type": "string",            "renditions": [              {                "renditionId": "string",                "conversion": "string",                "language": "string",                "mime": "string",                "filename": "string",                "fetchedUrl": "http://example.com",                "links": {                  "content": "http://example.com"                }              }            ]          }        ]      },      "links": {        "self": "http://example.com"      }    }  ],  "links": {    "self": "http://example.com"  }}

List entity changes GET

Change resources use type `entity-change`. Snapshot fields are spread into `attributes` alongside `changeType`, `changedKeys`, `mergedInto`, and `recordedAt`. The `entity` relationship uses the domain type from the snapshot. `meta.cursor` advances even when a filtered page is empty, so clients do not re-scan the same non-matching window. `links.next` is present when another page of matching changes may exist. GFFS qualifier string. Free-text terms are rejected. Allowed fields: type, title, name, displayDate, jurisdiction, localIdentifier, localType, authority, status. Change metadata (changeType, changedKeys, recordedAt) is not filterable. Operators: equality / multi-value OR, `~` contains, `>`, `>=`, `<`, `<=`, `..` ranges, and leading `-` negation (where valid). Filters apply to the post-change snapshot. Tombstones (empty entity) typically do not match.