Google Sheets

List destination spreadsheets for a connection

Returns the spreadsheets registered as sync destinations on this connection.

GET

/destinations/google-sheets/connections/{connectionId}/sheets

curl --request GET \
  --url https://api.synci.io/api/v1/destinations/google-sheets/connections/{connectionId}/sheets \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "balance_history_sheet_gid": "<string>",
      "balance_history_sheet_name": "<string>",
      "connection": {
        "auth_url": "<string>",
        "created_at": "<string>",
        "enabled": "<string>",
        "google_email": "<string>",
        "health": {
          "failure_count": "<string>",
          "integrator_message": "<string>",
          "last_attempt_at": "<string>",
          "status": "<string>",
          "transient_failure_count": "<string>",
          "transient_message": "<string>"
        },
        "id": "<string>",
        "last_synced_at": "<string>",
        "name": "<string>",
        "sheets": [
          {}
        ],
        "updated_at": "<string>"
      },
      "connection_id": "<string>",
      "created_at": "<string>",
      "health": {
        "failure_count": "<string>",
        "integrator_message": "<string>",
        "last_attempt_at": "<string>",
        "status": "<string>",
        "transient_failure_count": "<string>",
        "transient_message": "<string>"
      },
      "id": "<string>",
      "is_synci_managed": "<string>",
      "last_synced_at": "<string>",
      "live_balance_sheet_gid": "<string>",
      "live_balance_sheet_name": "<string>",
      "name": "<string>",
      "spreadsheet_id": "<string>",
      "spreadsheet_name": "<string>",
      "spreadsheet_url": "<string>",
      "transactions_sheet_gid": "<string>",
      "transactions_sheet_name": "<string>",
      "transfer_links": [
        {
          "active": "<string>",
          "created_at": "<string>",
          "destination": {
            "balance": "<string>",
            "budget": {
              "accounts": [
                {}
              ],
              "connection": {
                "auth_url": "<string>",
                "budgets": [
                  {}
                ],
                "created_at": "<string>",
                "enabled": "<string>",
                "health": {
                  "failure_count": "<string>",
                  "integrator_message": "<string>",
                  "last_attempt_at": "<string>",
                  "status": "<string>",
                  "transient_failure_count": "<string>",
                  "transient_message": "<string>"
                },
                "id": "<string>",
                "last_synced_at": "<string>",
                "name": "<string>",
                "sync_balances": "<string>",
                "updated_at": "<string>",
                "ynab_user_id": "<string>"
              },
              "connection_id": "<string>",

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connectionIdintegerrequired

The Google Sheets connection ID

Query Parameters

page[size]integerquerydefault:25

The number of results that will be returned per page.

page[number]integerquery

The page number to start the pagination from.

sortenum<string>[]querydefault:["-id"]

includeenum<string>[]query

Response

Paginated set of GoogleSheetResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team