Check a spreadsheet

GET

/api/v1/google-sheets/spreadsheets

curl --request GET \
  --url 'https://digize.com/api/v1/google-sheets/spreadsheets?spreadsheet=example' \
  --header 'x-api-key: <x-api-key>'

• Digize

A Google spreadsheet by its link or id: its title, and each sheet with the columns in its first row, which the Sheets row node matches values to. It also checks the connected Google account can open it.

Needs the automations:read permission.

Authorizations

• apiKey
• bearer

Parameters

Query Parameters

spreadsheet

required

The spreadsheet’s link, or its id.

string

>= 1 characters <= 500 characters

The spreadsheet’s link, or its id.

Responses

200

Done

Media typeapplication/json

object

id

required

string

title

required

string

url

required

string

sheets

required

Array<object>

object

title

required

string

columns

required

Array<string>

Example ^generated

{
  "id": "example",
  "title": "example",
  "url": "example",
  "sheets": [
    {
      "title": "example",
      "columns": [
        "example"
      ]
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}