GET
Get fee schedule results by version

Overview

Returns all fee schedule results belonging to a specific extraction version. Each version represents a single extraction run against a fee schedule document. Use this to retrieve the complete set of fees from that version. Results are access-scoped — you can only retrieve versions for exchanges associated with your API key.
Authorization Required - Include your API key in the x-rulebook-api-access-key header. Contact aaron@rulebookcompany.com to obtain access.
You can find version_id values in the response of the List Fee Schedule Results or Get Fee Schedule Result endpoints.

Path Parameters

string (uuid)
required
Fee extraction version identifier. Obtain this from the version_id field in fee schedule results.

Query Parameters

integer
default:"20"
Records per page (1–100)
integer
default:"0"
Page number (0-indexed)
boolean
default:"false"
When true, includes resolved footnotes from the source document in the relationships field of each result.
boolean
default:"false"
When true, includes resolved definitions from the source document in the relationships field of each result.
boolean
default:"false"
When true, includes source_document, source_link, and page_number fields in each result.

Request

With Pagination and Source

Response

array
Array of fee schedule result objects (same schema as the list endpoint)
object
Pagination and performance metadata

Example Response

Error Responses

Authorizations

x-rulebook-api-access-key
string
header
required

API access key provided by Rulebook Company. Contact aaron@rulebookcompany.com to obtain one.

Path Parameters

version_id
string<uuid>
required

Fee extraction version identifier (from the version_id field in fee schedule results)

Query Parameters

page_size
integer
default:20

Number of records per page (1-100)

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

Page number (0-indexed)

Required range: x >= 0
include_footnotes
boolean
default:false

When true, includes resolved footnotes from the source document in the relationships field of each result

include_definitions
boolean
default:false

When true, includes resolved definitions from the source document in the relationships field of each result

include_source
boolean
default:false

When true, includes source_document, source_link, and page_number fields in each result

Response

Paginated fee schedule results for the specified version

data
object[]
meta
object

Pagination and performance metadata