Google Sheets

List all Google Sheets connections

Returns the Google Sheets connections that belong to the authenticated user. Connections that never completed Google authorization are not included.

GET

/destinations/google-sheets/connections

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

{
  "data": [
    {
      "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": [
        {
          "balance_history_sheet_gid": "<string>",
          "balance_history_sheet_name": "<string>",
          "connection": {},
          "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": {},
                  "connection_id": "<string>",
                  "created_at": "<string>",
                  "currency": "<string>",
                  "enabled": "<string>",
                  "first_month": "<string>",
                  "id": "<string>",
                  "last_month": "<string>",
                  "last_synced_at": "<string>",
                  "name": "<string>",
                  "updated_at": "<string>",
                  "ynab_id": "<string>"
                },
                "budget_id": "<string>",
                "cleared_balance": "<string>",
                "closed": "<string>",
                "created_at": "<string>",
                "direct_import_linked": "<string>",
                "health": {
                  "failure_count": "<string>",
                  "integrator_message": "<string>",
                  "last_attempt_at": "<string>",
                  "status": "<string>",
                  "transient_failure_count": "<string>",
                  "transient_message": "<string>"
                },
                "id": "<string>",
                "last_reconciled_at": "<string>",

Authorizations

Authorizationstringheaderrequired

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

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.

filter[enabled]stringquery

Filter by whether the connection is enabled (true/false).

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

includeenum<string>[]query

Response

Paginated set of GoogleSheetsConnectionResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team