Regbase API
Reference

List entity changes

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.

GET
/v1/entities/changes

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.

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key. Send Authorization: Bearer rb_live_….

In: header

Query Parameters

filter*string

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.

Length1 <= length
page[after]?string

Opaque change id cursor (echg_…) from the previous page's meta.cursor.

page[limit]?integer

Page size. Default 100, maximum 100.

Range1 <= value <= 100

Response Body

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

curl -X GET "https://example.com/v1/entities/changes?filter=string"
{  "data": [    {      "type": "entity-change",      "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"                }              }            ]          }        ],        "changeType": "create",        "changedKeys": [          "string"        ],        "mergedInto": "string",        "recordedAt": "2019-08-24T14:15:22Z"      },      "relationships": {        "entity": {          "data": {            "type": "string",            "id": "string"          },          "links": {            "related": "http://example.com"          }        }      }    }  ],  "links": {    "self": "http://example.com",    "next": "http://example.com"  },  "meta": {    "cursor": "string"  }}

List entities GET

Returns canonical entities (not drained or merged, not empty snapshots) ordered by id. Optional GFFS qualifier string. Omit to list all entities. Free-text terms are rejected. Allowed fields: type, title, name, displayDate, jurisdiction, localIdentifier, localType, authority, status.

Search entities GET

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.