Skip to main content
GET
Export a fact register or history

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60

Query Parameters

kind
enum<string> | null

register (the default) or history.

Available options:
register,
history
as_at
string | null
format
enum<string> | null

The file download_url gives: pdf (the default) or csv.

Available options:
pdf,
csv

Response

Success.

object
enum<string>
required
Available options:
fact_export
client_id
string
required
kind
enum<string>
required
Available options:
register,
history
as_at
string
required
fact_count
number
required

Facts the firm keeps, archived ones left out.

held_count
number
required

How many of them held a value that day.

values
object[] | null
required

For a register: the values that stood at the end of as_at.

changes
object[] | null
required

For a history: every change up to the end of as_at, oldest first.

file_name
string
required
download_url
string | null
required

The PDF or CSV. Works for 15 minutes.

download_expires_at
string | null
required

An ISO 8601 time in UTC.