Sheets

List cells

Requires Forecast: View. Searches authored cell contents and formula text, not calculated financial results. Matches identify the worksheet and cell address. Cursor paging is tied to the document revision; reread/restart if the document changes. Matching is case-insensitive. Results contain authored string inputs in worksheet, row and column order, skipping blank cells. Cursors bind the search filters and revision; a wrong-search cursor returns 400, and a changed revision returns 409. Unknown query parameters return 400.

GET

sheets

{id}

cells

List cells

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

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

fetch('https://app.finta.com/api/v1/sheets/{id}/cells', 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}/cells",
  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}/cells"

	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}/cells")

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

{
  "object": "list",
  "url": "<string>",
  "data": [
    {
      "worksheet_id": "<string>",
      "worksheet_name": "<string>",
      "cell": "<string>",
      "input": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "revision": 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

query

string

required

Required string length: 1 - 1000

match

enum<string>

default:contains

contains matches a substring; exact matches the whole authored input. Both are case-insensitive and do not search calculated results.

Available options:

contains,

exact

worksheet_id

string

limit

integer

default:100

Required range: 1 <= x <= 500

starting_after

string

Opaque next_cursor from the prior page; preserve all filters.

Response

A page of matching authored cells.

object

enum<string>

required

Available options:

list

url

string

required

data

object[]

required

Show child attributes

has_more

boolean

required

next_cursor

string | null

required

revision

integer

required

Required range: x >= 0

List cells

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

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

fetch('https://app.finta.com/api/v1/sheets/{id}/cells', 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}/cells",
  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}/cells"

	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}/cells")

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

{
  "object": "list",
  "url": "<string>",
  "data": [
    {
      "worksheet_id": "<string>",
      "worksheet_name": "<string>",
      "cell": "<string>",
      "input": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "revision": 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

List cells

Authorizations

Path Parameters

Query Parameters

Response