Sheets

Retrieve sheet

Requires Forecast: View. Without ranges, returns document and worksheet metadata. Grid reads use qualified A1 addresses; quote worksheet names and escape embedded apostrophes by doubling them. Evaluation is read-only and uses the existing formula engine and company financial data. Numeric spreadsheet cells preserve worksheet units. Metadata-only responses omit ranges and calculation. Ranges must be bounded, ordered and inside the existing grid. Unqualified ranges require worksheet_id unless the document has exactly one worksheet.

GET

sheets

{id}

Retrieve sheet

curl --request GET \
  --url https://app.finta.com/api/v1/sheets/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.finta.com/api/v1/sheets/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.finta.com/api/v1/sheets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.finta.com/api/v1/sheets/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.finta.com/api/v1/sheets/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "revision": 1,
  "worksheets": [
    {
      "id": "<string>",
      "name": "<string>",
      "used_range": "<string>",
      "row_count": 2,
      "column_count": 2,
      "charts": [
        {
          "id": "<string>",
          "type": "bar",
          "source_range": "<string>",
          "source_ranges": [
            "<string>"
          ],
          "series_orientation": "columns",
          "anchor_cell": "A1",
          "width": 408,
          "height": 240,
          "offset_x": 0,
          "offset_y": 0,
          "title": "<string>",
          "x_axis_title": "<string>",
          "y_axis_title": "<string>",
          "show_title": true,
          "show_x_axis_title": true,
          "show_x_axis_labels": true,
          "show_y_axis_title": true,
          "show_y_axis_labels": true,
          "show_data_labels": true,
          "show_legend": true,
          "series": [
            {
              "name": "<string>",
              "source_range": "<string>",
              "color": "blue",
              "name_range": "<string>",
              "category_range": "<string>",
              "category_cells": [
                "<string>"
              ]
            }
          ]
        }
      ]
    }
  ],
  "ranges": [
    {
      "worksheet_id": "<string>",
      "range": "<string>",
      "values": [
        [
          "<string>"
        ]
      ],
      "formulas": [
        [
          "<string>"
        ]
      ],
      "formats": [
        {
          "range": "<string>",
          "format": {
            "align": "left",
            "auto_align": "right",
            "background_color": "<string>",
            "bold": true,
            "borders": {
              "top": "<string>",
              "right": "<string>",
              "bottom": "<string>",
              "left": "<string>"
            },
            "decimals": 5,
            "font_size": "heading",
            "indent": 5,
            "italic": true,
            "number_style": "number",
            "reference_kind": "department",
            "text_color": "<string>"
          }
        }
      ]
    }
  ],
  "calculation": {
    "status": "complete",
    "errors": [
      {
        "code": "<string>",
        "message": "<string>",
        "worksheet_id": "<string>",
        "cell": "<string>",
        "formula": "<string>"
      }
    ],
    "warnings": [
      {
        "code": "<string>",
        "message": "<string>",
        "formula": "<string>",
        "count": 1
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

API key prefixed with finta_

Path Parameters

string

required

Document ID returned by list. Worksheet IDs are distinct.

Query Parameters

ranges[]

string[]

Use ranges[]=Plan!A1:B3 and repeat ranges[] for multiple selections. A single ranges string is also accepted. At most 100 ranges and 10,000 selected cells in total.

Required array length: 1 - 100 elements

worksheet_id

string

Optional stable worksheet selector for unqualified ranges.

view

enum<string>

default:values

values returns calculated values; formulas returns saved formulas with null for non-formula cells and skips calculation; both returns both matrices.

Available options:

values,

formulas,

both

include

string

Comma-separated charts,formats. Both are opt-in. charts returns embedded definitions rather than images; formats requires selected ranges.

Response

Document metadata and requested range content.

string

required

name

string

required

url

string

required

revision

integer

required

Required range: x >= 0

worksheets

object[]

required

Show child attributes

ranges

object[]

Show child attributes

calculation

object

Bounded synchronous calculation; no pending job is created. error means one or more formulas failed. unavailable means evaluation could not run; values are omitted rather than invented. Formula-error cells have null values and corresponding errors. A write can be saved even when this status is not complete.

Show child attributes

Retrieve sheet

curl --request GET \
  --url https://app.finta.com/api/v1/sheets/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.finta.com/api/v1/sheets/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.finta.com/api/v1/sheets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.finta.com/api/v1/sheets/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.finta.com/api/v1/sheets/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "revision": 1,
  "worksheets": [
    {
      "id": "<string>",
      "name": "<string>",
      "used_range": "<string>",
      "row_count": 2,
      "column_count": 2,
      "charts": [
        {
          "id": "<string>",
          "type": "bar",
          "source_range": "<string>",
          "source_ranges": [
            "<string>"
          ],
          "series_orientation": "columns",
          "anchor_cell": "A1",
          "width": 408,
          "height": 240,
          "offset_x": 0,
          "offset_y": 0,
          "title": "<string>",
          "x_axis_title": "<string>",
          "y_axis_title": "<string>",
          "show_title": true,
          "show_x_axis_title": true,
          "show_x_axis_labels": true,
          "show_y_axis_title": true,
          "show_y_axis_labels": true,
          "show_data_labels": true,
          "show_legend": true,
          "series": [
            {
              "name": "<string>",
              "source_range": "<string>",
              "color": "blue",
              "name_range": "<string>",
              "category_range": "<string>",
              "category_cells": [
                "<string>"
              ]
            }
          ]
        }
      ]
    }
  ],
  "ranges": [
    {
      "worksheet_id": "<string>",
      "range": "<string>",
      "values": [
        [
          "<string>"
        ]
      ],
      "formulas": [
        [
          "<string>"
        ]
      ],
      "formats": [
        {
          "range": "<string>",
          "format": {
            "align": "left",
            "auto_align": "right",
            "background_color": "<string>",
            "bold": true,
            "borders": {
              "top": "<string>",
              "right": "<string>",
              "bottom": "<string>",
              "left": "<string>"
            },
            "decimals": 5,
            "font_size": "heading",
            "indent": 5,
            "italic": true,
            "number_style": "number",
            "reference_kind": "department",
            "text_color": "<string>"
          }
        }
      ]
    }
  ],
  "calculation": {
    "status": "complete",
    "errors": [
      {
        "code": "<string>",
        "message": "<string>",
        "worksheet_id": "<string>",
        "cell": "<string>",
        "formula": "<string>"
      }
    ],
    "warnings": [
      {
        "code": "<string>",
        "message": "<string>",
        "formula": "<string>",
        "count": 1
      }
    ]
  }
}

API Reference

Sheets

Taxes

Files

Company

Plans & billing

Team

Categories

Rules

Departments

Integrations

Aggregations

Transactions

Forms

Journal Entries

Invoices

Parties

Reports

Feedback

Tax Credits

Retrieve sheet

Authorizations

Path Parameters

Query Parameters

Response