Developer Dashboard

Getting Started
Authentication

Gigasheet API

End to End Example
Filter Model Detail Guide
Billing and Costs
ai
billing
- List available Gigasheet plans.get
data
file
share
comments
filter
export
audit
data_cleanup
- Delete duplicated rowsdelete
- Count duplicated rowspost
enrich
user
upload
- Raw data direct uploadpost
- Upload from URLpost

Developer Dashboard

Getting Started
Authentication

Gigasheet API

End to End Example
Filter Model Detail Guide
Billing and Costs
ai
billing
- List available Gigasheet plans.get
data
file
share
comments
filter
export
audit
data_cleanup
- Delete duplicated rowsdelete
- Count duplicated rowspost
enrich
user
upload
- Raw data direct uploadpost
- Upload from URLpost

Get parameters for source.

post https://api.gigasheet.com/connectors/sources/params/{connectorName}

For a given source type, get the relevant parameters that need to be supplied by the user.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

connectorName

string

required

Integration to get parameters for

Responses

Response body

object

ConsentURL

string

If present, OAuth consent url for connector

ConsentURLParams

array of objects

Shown to users if they are needed for building consent url

ConsentURLParams

object

Choices

array of objects

optional list of choices for user to select from; only present for type default and array

Choices

object

Label

string

Value

string

Name

string

name of parameter shown to user

Placeholder

string

optional placeholder text for user to see in the input field

Type

string

type of parameter (e.g. default, password, array, date)

default date datetime boolean array password file

Description

string

Connector description as shown to user

Name

string

Display name used when presenting connector to user

Snowflake Snowflake SSO Snowflake Live Query Snowflake SSO Live Query Google Analytics MySQL PostgreSQL HubSpot Salesforce Objects Salesforce Report Freshsales Databricks Databricks Delta Share Databricks Live Query BigQuery Amazon Athena Amazon Redshift Microsoft SQL Server

Params

array of objects

Params shown to user (may not be all required params if some are implicit)

Params

object

Choices

array of objects

optional list of choices for user to select from; only present for type default and array

Choices

object

Label

string

Value

string

Name

string

name of parameter shown to user

Placeholder

string

optional placeholder text for user to see in the input field

Type

string

type of parameter (e.g. default, password, array, date)

default date datetime boolean array password file

Response body

json

Response body

json

Response body

json

Response body

json

Updated 7 months ago

Get parameters for source.

Delete a source.

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.gigasheet.com/connectors/sources/params/connectorName \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 7 months ago

Get parameters for source.

Delete a source.

Did this page help you?

Developer Dashboard
Getting Startedget
Authenticationget

Gigasheet API
End to End Example
Filter Model Detail Guide
Billing and Costs
ai
Delete Sheet Assistant historydelete
Sheet Assistant Historyget
Formula Builderpost
Sheet Assistantpost
billing
List available Gigasheet plans.get
data
Trims a column's whitespacepost
Split columnpost
Cross file lookuppost
Delete multiple columns in a sheetpost
Delete columndelete
Get Aggregationspost
Extract domain from URL column.post
Explode the column with JSONpost
Get all supported formulas functions.get
Delete sheetdelete
Insert a new row with empty/null valuespost
Describe dataset versionget
Upsert rows in a sheetput
Update a single cell using column name and row number.put
Updates a single cellput
Select columns by namepost
Rename columns by namepost
Ensure column names are uniquepost
Get operation statusget
Add iterator columnpost
Validate a given formula.post
Formula sample result.post
Edit a formulapost
Run a given formula.post
Find and replace values in a sheetpost
Generate descriptionpost
Delete rows not matching a filterdelete
Delete rows matching a filterdelete
Delete rowsdelete
Add conditional labels to rowspost
Unset currency for a columndelete
Set currency for a columnput
Get Columnsget
Generate tipspost
Append to a sheet data from another sheetpost
Append to a sheetpost
Append to a sheetpost
Describe datasetget
Get column statistics.post
Return the number of unique tuple values in a list of columnspost
Get sheet statistics.post
Initiate export of a dataset to the given connector.post
Unpause a connector.patch
Get source status.get
Check if source is available.post
Delete a source.delete
Get parameters for source.post
Get parameters for source.get
Create a source.post
Get connected data source information.get
Reset a connector.delete
Pause a connector.patch
Get parameters for export given parameters provided by user.post
Get parameters for export.get
Run/schedule a connection.post
Retrieve connection infos.get
Get headers.post
Get connection.get
Get the relevant parameters to start an import.post
Get parameters for connection.get
Create a connection.post
Combine columnspost
Clean company names.post
Changes a string's case based on payloadpost
Change column data typepost
file
Get space usedget
Get enrichment creditsget
Rename filepost
Datasets in dirget
Shared with my team files in dirget
Shared with my team files at rootget
Shared files in dirget
Shared files at rootget
Search Librarypost
Get pathget
Get home page datasetsget
List exportsget
Datasets at rootget
Get a new handleget
Create folderpost
Create folderpost
Validate combine requestpost
Validate combine by name requestpost
Combine files by namepost
Combine filespost
Create an empty filepost
Move file or folderput
Copy filepost
List files in the given location.get
List files at the root directory.get
Create linked sheetpost
Update viewpatch
Delete viewdelete
Get viewget
Create viewpost
List viewsget
Save current viewpost
Sets a file's note with a max length of 20K charactersput
Returns a file's noteget
Set client state by version idput
Set client stateput
Set visible columnsput
Set sort modelput
Reset client stateput
Set group columnsput
Set filter modelput
Get current sheet state versionget
Set column stateput
Set aggregationsput
Set aggregate filter modelput
share
Request access to a filepost
Opt out of file that has been shared with youput
Share a file with othersput
Set organization permissions on fileput
Get organization permissions for fileget
Lists all liveshares and their details for a provided sheetget
Creates a string of CSV data representing a sheetget
Creates a Share ID for a sheetpost
Delete a live share of a filedelete
comments
Get cell commentsget
Delete a cell commentdelete
Add a cell commentpost
Get column commentsget
Delete a column commentdelete
Add a column commentpost
Get all commentsget
filter
Get filter model for saved filterget
Delete saved filterdelete
Create or update saved filterput
Describe saved filterget
List saved filtersget
Row number in filter resultpost
Filter datapost
Filter datapost
Get filtered data row countpost
Get filtered group countpost
export
Creates and saves a file state so as to also contain any applied filters and groupingpost
Create exportpost
Download exportget
audit
Search action historypost
Total activity countpost
Get action historyget
data_cleanup
Count duplicated rowspost
Delete duplicated rowsdelete
enrich
Cancels the given enrichment task.post
Get status for the given generic enrichment task.get
Preview of a generic HTTP enrichmentpost
Calculate expected credits used by the enrichmentpost
Apply generic HTTP enrichmentpost
Lists active enrichment tasks.get
Enrich data on demandpost
Enrich datapost
Enrich datapost
Enrich datapost
user
Get users autofill infoget
User infoget
Trigger password reset for requestor.post
Remove user from the teampost
Updates user metadatapatch
User metadataget
Detailed user infoget
Issue API keypost
Revoke API keysdelete
Sends an email invitation to the list of email addresses to join the Gigasheetpost
Request access to Gigasheet APIpost
upload
Upload from URLpost
Raw data direct uploadpost

Developer Dashboard
Getting Startedget
Authenticationget

Gigasheet API
End to End Example
Filter Model Detail Guide
Billing and Costs
ai
Delete Sheet Assistant historydelete
Sheet Assistant Historyget
Formula Builderpost
Sheet Assistantpost
billing
List available Gigasheet plans.get
data
Trims a column's whitespacepost
Split columnpost
Cross file lookuppost
Delete multiple columns in a sheetpost
Delete columndelete
Get Aggregationspost
Extract domain from URL column.post
Explode the column with JSONpost
Get all supported formulas functions.get
Delete sheetdelete
Insert a new row with empty/null valuespost
Describe dataset versionget
Upsert rows in a sheetput
Update a single cell using column name and row number.put
Updates a single cellput
Select columns by namepost
Rename columns by namepost
Ensure column names are uniquepost
Get operation statusget
Add iterator columnpost
Validate a given formula.post
Formula sample result.post
Edit a formulapost
Run a given formula.post
Find and replace values in a sheetpost
Generate descriptionpost
Delete rows not matching a filterdelete
Delete rows matching a filterdelete
Delete rowsdelete
Add conditional labels to rowspost
Unset currency for a columndelete
Set currency for a columnput
Get Columnsget
Generate tipspost
Append to a sheet data from another sheetpost
Append to a sheetpost
Append to a sheetpost
Describe datasetget
Get column statistics.post
Return the number of unique tuple values in a list of columnspost
Get sheet statistics.post
Initiate export of a dataset to the given connector.post
Unpause a connector.patch
Get source status.get
Check if source is available.post
Delete a source.delete
Get parameters for source.post
Get parameters for source.get
Create a source.post
Get connected data source information.get
Reset a connector.delete
Pause a connector.patch
Get parameters for export given parameters provided by user.post
Get parameters for export.get
Run/schedule a connection.post
Retrieve connection infos.get
Get headers.post
Get connection.get
Get the relevant parameters to start an import.post
Get parameters for connection.get
Create a connection.post
Combine columnspost
Clean company names.post
Changes a string's case based on payloadpost
Change column data typepost
file
Get space usedget
Get enrichment creditsget
Rename filepost
Datasets in dirget
Shared with my team files in dirget
Shared with my team files at rootget
Shared files in dirget
Shared files at rootget
Search Librarypost
Get pathget
Get home page datasetsget
List exportsget
Datasets at rootget
Get a new handleget
Create folderpost
Create folderpost
Validate combine requestpost
Validate combine by name requestpost
Combine files by namepost
Combine filespost
Create an empty filepost
Move file or folderput
Copy filepost
List files in the given location.get
List files at the root directory.get
Create linked sheetpost
Update viewpatch
Delete viewdelete
Get viewget
Create viewpost
List viewsget
Save current viewpost
Sets a file's note with a max length of 20K charactersput
Returns a file's noteget
Set client state by version idput
Set client stateput
Set visible columnsput
Set sort modelput
Reset client stateput
Set group columnsput
Set filter modelput
Get current sheet state versionget
Set column stateput
Set aggregationsput
Set aggregate filter modelput
share
Request access to a filepost
Opt out of file that has been shared with youput
Share a file with othersput
Set organization permissions on fileput
Get organization permissions for fileget
Lists all liveshares and their details for a provided sheetget
Creates a string of CSV data representing a sheetget
Creates a Share ID for a sheetpost
Delete a live share of a filedelete
comments
Get cell commentsget
Delete a cell commentdelete
Add a cell commentpost
Get column commentsget
Delete a column commentdelete
Add a column commentpost
Get all commentsget
filter
Get filter model for saved filterget
Delete saved filterdelete
Create or update saved filterput
Describe saved filterget
List saved filtersget
Row number in filter resultpost
Filter datapost
Filter datapost
Get filtered data row countpost
Get filtered group countpost
export
Creates and saves a file state so as to also contain any applied filters and groupingpost
Create exportpost
Download exportget
audit
Search action historypost
Total activity countpost
Get action historyget
data_cleanup
Count duplicated rowspost
Delete duplicated rowsdelete
enrich
Cancels the given enrichment task.post
Get status for the given generic enrichment task.get
Preview of a generic HTTP enrichmentpost
Calculate expected credits used by the enrichmentpost
Apply generic HTTP enrichmentpost
Lists active enrichment tasks.get
Enrich data on demandpost
Enrich datapost
Enrich datapost
Enrich datapost
user
Get users autofill infoget
User infoget
Trigger password reset for requestor.post
Remove user from the teampost
Updates user metadatapatch
User metadataget
Detailed user infoget
Issue API keypost
Revoke API keysdelete
Sends an email invitation to the list of email addresses to join the Gigasheetpost
Request access to Gigasheet APIpost
upload
Upload from URLpost
Raw data direct uploadpost

200OK

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error