Skip to content
Changelog

Report a bug

Gigasheet integration: operations for AI agents

Gigasheet connects to Type.com as an integration. This page lists the 171 operations documented for Claude and Codex in Type.com: 65 read, 69 write, 37 destructive.

About Gigasheet

Gigasheet is a big data automation platform that offers a spreadsheet-like interface for analyzing and managing large datasets, enabling users to automate tasks, integrate with various data sources, and streamline data workflows.

Categories: Analytics & Data

How to connect Gigasheet to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

171 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

171 operations listed.

Ai

  • Read

    Sheet Assistant History

    Get history of recent messages with the sheet assistant

    GET /ai/{handle}/logs

  • Read

    Query a sheet with GigaScript

    Run a read-only GigaScript program against a sheet and return matching rows, optional counts and a permalink to the results.

    POST /dataset/{handle}/query

  • Write

    Sheet Assistant

    AI analysis assistant, only available for sheets where you have write permissions

    POST /ai/{handle}/chat

  • Write

    Formula Builder

    AI formula builder, available for sheets where you have read permissions

    POST /ai/{handle}/formulate

  • Write

    Model Context Protocol endpoint

    Implements the Model Context Protocol (MCP) over HTTP, allowing an LLM to query Sheet Assistant as an MCP Tool. To use, send stdin from the LLM as the body of a POST to this endpoint, and send the response back over stdout Example body: {"method":"tools/list","params":{"protocolVersion":"2024-11-05","capabilities":{}},"jsonrpc":"2.0","id":0}.

    POST /mcp

  • Destructive

    Delete Sheet Assistant history

    Delete the sheet assistant messages

    DELETE /ai/{handle}/logs

Billing

  • Read

    List available Gigasheet plans.

    GET /billing/plans

    GET /billing/plans

Data

  • Read

    Get parameters for connection.

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

    GET /connectors/connection/params/{connectorName}

  • Read

    Get the relevant parameters to start an import.

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

    POST /connectors/connection/params/{connectorName}

  • Read

    Get connection.

    Returns connection details for a given connection ID.

    GET /connectors/connection/{connectionId}

  • Read

    Get headers.

    Returns headers for a given stream and connection ID.

    POST /connectors/connection/{connectionId}/headers

  • Read

    Retrieve connection infos.

    Retrieves connections information relevant to the user.

    GET /connectors/connections

  • Read

    Get parameters for export.

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

    GET /connectors/export/params/{connectorName}

  • Read

    Get parameters for export given parameters provided by user.

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

    POST /connectors/export/params/{connectorName}

  • Read

    Get connected data source information.

    Retrieves information about connected data sources for the user.

    GET /connectors/sources

  • Read

    Get parameters for source.

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

    GET /connectors/sources/params/{connectorName}

  • Read

    Get parameters for source.

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

    POST /connectors/sources/params/{connectorName}

  • Read

    Check if source is available.

    Checks if a source of the given source type for user is available. Updates corresponding connections statuses.

    POST /connectors/sources/{connectorName}/check

  • Read

    Get source status.

    Get source status for a given source type for the user.

    GET /connectors/sources/{connectorName}/status

  • Read

    Describe dataset

    This endpoint returns metadata about a dataset. It includes things like file name, column names and types, and modification timestamp.

    GET /dataset/{handle}

  • Read

    Get Columns

    Get column details for a sheet, including column IDs

    GET /dataset/{handle}/columns

  • Read

    Find and replace values in a sheet

    This endpoint will return a new column with original column's name and updated 'found' values while updating original column's name to ‘Original Values - [column name]

    POST /dataset/{handle}/find-and-replace

  • Read

    Validate a given formula.

    Validate a given formula.

    POST /dataset/{handle}/formula/validate

  • Read

    Get operation status

    Get information about the last operation.

    GET /dataset/{handle}/operation-status

  • Read

    Describe dataset version

    This endpoint returns metadata about a dataset in a specific version. It includes things like file name, column names and types, and modification timestamp.

    GET /dataset/{handle}/{version}

  • Read

    Get all supported formulas functions.

    Returns the JSON that contains all supported functions with documentation.

    GET /docs/formulas/functions

  • Read

    Get Aggregations

    Returns ungrouped aggregated values as specified in the grid payload

    POST /file/{handle}/aggregation

  • Write

    Change column data type

    This endpoint returns a Json response acknowledging if the request to change data type was successful.

    POST /cast-column/{handle}/{column}

  • Write

    Changes a string's case based on payload

    This endpoint changes the case of a column to Uppercase, Lowercase, Capitalized, or Proper

    POST /change-case/{handle}/{col}

  • Write

    Clean company names.

    Clean company names by stripping suffixes. Currently, this works on English-alphabet versions of names.

    POST /clean-company-name/{handle}/{col}

  • Write

    Combine columns

    This endpoint returns a Json response acknowledging if the request to combine columns was successful.

    POST /combine-columns/{handle}

  • Write

    Create a connection.

    Creates a connection and returns the connection id and headers (fields) associated with the connection.

    POST /connectors/connection/create

  • Write

    Run/schedule a connection.

    Creates (if needed) and runs a connection with the given configuration. If a schedule is passed, the connector will be run on that schedule. (If there was an existing schedule, it will be overwritten.)

    POST /connectors/create

  • Write

    Pause a connector.

    Pauses any scheduled runs for the given connector.

    PATCH /connectors/pause/{connectionId}

  • Write

    Create a source.

    Creates a source of the given source type for user.

    POST /connectors/sources/create

  • Write

    Unpause a connector.

    Unpauses any scheduled runs for the given connector.

    PATCH /connectors/unpause/{connectionId}

  • Write

    Initiate export of a dataset to the given connector.

    Initiates an export of the dataset to the given connector.

    POST /connectors/{handle}/export

  • Write

    Append to a sheet

    Append rows to an existing sheet.

    POST /dataset/{handle}/append

  • Write

    Append to a sheet

    Append rows to an existing sheet. Uses column names rather than ids.

    POST /dataset/{handle}/append/by-name

  • Write

    Append to a sheet data from another sheet

    Append data from a source sheet to the target sheet. Uses column names rather than ids. Matches columns from the source sheet to the target sheet based on column names.

    POST /dataset/{handle}/append/from-sheet/{from-handle}/by-name

  • Write

    Generate tips

    Generate tips for analyses.

    POST /dataset/{handle}/assistant-tips

  • Write

    Add conditional labels to rows

    Add a label column to the dataset with values based on specified conditions

    POST /dataset/{handle}/conditional-label-column

  • Write

    Generate description

    Generate description of the sheet.

    POST /dataset/{handle}/description

  • Write

    Run a given formula.

    Create a new column based on the given formula input. A blank column can be generated with the formula "" .

    POST /dataset/{handle}/formula

  • Write

    Edit a formula

    Replace a column created using a formula with a new formula.

    POST /dataset/{handle}/formula/edit/{column}

  • Write

    Formula sample result.

    Calculates a formula sample result and returns it back along with involved column values.

    POST /dataset/{handle}/formula/preview

  • Write

    Add iterator column

    Add an iterator column to the dataset based on current filters and order of the data.

    POST /dataset/{handle}/iterator-column

  • Write

    Ensure column names are unique

    Renames the columns in the sheet if needed, ensuring that all columns end up with unique names. Preserves original names of columns when possible if they are already unique.

    POST /dataset/{handle}/rename-columns-to-unique

  • Write

    Rename columns by name

    Renames the columns in the sheet using column names.

    POST /dataset/{handle}/rename-columns/by-name

  • Write

    Select columns by name

    Makes the file have only the provided columns, in the specified order. Deletes all other columns. Always keeps the row number column.

    POST /dataset/{handle}/select-columns/by-name

  • Write

    Insert a new row with empty/null values

    This endpoint will return a new row with initalized null value at the index provided

    POST /datasets/{handle}/insert-blank-row

  • Write

    Explode the column with JSON

    This endpoint extracts all keys in the request from JSON in the given column and adds a new column for each. If there was no key provided it will proceed with the most common keys up to 2000.

    POST /explode-json/{handle}/{column}

  • Write

    Extract domain from URL column.

    Extracts the domain from a URL.

    POST /extract-domain/{handle}/{col}

  • Write

    Cross file lookup

    This endpoint returns a Json response acknowledging if the lookup was successful.

    POST /lookup/{handle}/{col}

  • Write

    Split column

    Splits the values of a column into two or more columns based on a specified separator.

    POST /split-column/{handle}

  • Write

    Trims a column's whitespace

    This endpoint returns a Json response acknowledging if the whitespace trim was successful

    POST /trim-whitespace/{handle}/{col}

  • Write

    Explode the column with an array into multiple rows

    Explodes the arrays in a column into multiple rows. Each element of the array creates a new record. All other fields are kept.

    POST /unroll-delimited-column/{handle}/{column}

  • Destructive

    Reset a connector.

    Removes any scheduled runs for the given connector and resets the connector state.

    DELETE /connectors/reset/{type}/{connectorName}/{connectionId}

  • Destructive

    Delete a source.

    Deletes a source of the given source type for user.

    DELETE /connectors/sources/{connectorName}

  • Destructive

    Set currency for a column

    Sets the currency for the specified column.

    PUT /dataset/{handle}/columns/{column}/currency

  • Destructive

    Unset currency for a column

    Unsets the currency for the specified column.

    DELETE /dataset/{handle}/columns/{column}/currency

  • Destructive

    Delete multiple columns in a sheet by name

    This endpoint will delete multiple columns in a sheet by their names

    POST /dataset/{handle}/delete-columns/by-name

  • Destructive

    Delete rows

    Deletes selected rows in a file. The payload integer should be the row id (iterator ) of the row(s) to be deleted. The row id is subject to change and so best practice is to source it immediately before a delete.

    DELETE /dataset/{handle}/delete-rows

  • Destructive

    Delete rows matching a filter

    Deletes rows in a file that match the selected filter.

    DELETE /dataset/{handle}/delete-rows-matching-filter

  • Destructive

    Delete rows not matching a filter

    Deletes rows in a file that do not match the selected filter.

    DELETE /dataset/{handle}/delete-rows-not-matching-filter

  • Destructive

    Updates a single cell

    This endpoint returns a Json response acknowledging if the request to update a cell was successful.

    PUT /dataset/{handle}/{col}/{row}

  • Destructive

    Update a single cell using column name and row number.

    Updates the specified cell based on given column name and row number. Errors if column name not in sheet or multiple columns have the requested name.

    PUT /dataset/{handle}/{col}/{row}/by-name

  • Destructive

    Upsert rows in a sheet

    Upsert rows in an existing sheet. Column id and row number is used to specify start position. Note that overlapping cells will be overwritten.

    PUT /dataset/{handle}/{col}/{row}/upsert-rows

  • Destructive

    Delete sheet

    Deletes the given sheet or empty folder. If recursive, deletes folder and all children.

    DELETE /delete/{handle}

  • Destructive

    Delete column

    Deletes a column from the sheet.

    DELETE /files/{handle}/columns/{column}

  • Destructive

    Delete multiple columns in a sheet

    This endpoint will delete multiple columns in a sheet

    POST /files/{handle}/delete-multiple-columns

File

  • Read

    Get current sheet state version

    Returns information about the current version of the sheet state.

    GET /client-state/{handle}/current-version

  • Read

    Returns a file's note

    This endpoint returns a Json response acknowledging if the request to get a file's note. was successful as well as the file note itself as a string

    GET /dataset/{handle}/note

  • Read

    List views

    Returns the list of views on the sheet data.

    GET /dataset/{handle}/views

  • Read

    Get view

    Returns the view metadata.

    GET /dataset/{handle}/views/{view}

  • Read

    Get all datasets.

    Returns all datasets owned by the user at any folder depth. Since this may be a large amount of data may trim certain fields to keep response size manageable.

    GET /datasets

  • Read

    List files at the root directory.

    GET /datasets/

    GET /datasets/

  • Read

    List files in the given location.

    GET /datasets/{handle}

    GET /datasets/{handle}

  • Read

    Check federated table compatibility

    Checks whether the given member sheets can form a federated table and returns the proposed schema. Creates nothing.

    POST /federated/check

  • Read

    Validate combine by name request

    Validates the combine by name request and returns all errors that might appear.

    POST /files/combine/by-name/validate

  • Read

    Validate combine request

    Validates the combine files request and returns all errors that might appear.

    POST /files/combine/validate

  • Read

    Get a new handle

    Creates a new handle (also known as a FileUuid) and returns it. Note that this does not put anything into the database, it is not a sheet or anything, it's just a string that is a well-formed handle.

    GET /generateHandle

  • Read

    Datasets at root

    GET /library/

    GET /library/

  • Read

    List exports

    Lists exports owned by the current user, regardless of location.

    GET /library/exports

  • Read

    Get home page datasets

    Returns a list of suggested recent files for the home page.

    GET /library/home

  • Read

    Get path

    Get chain of parent directories including subject file/folder itself sorted by folder level

    GET /library/path/{handle}

  • Read

    Search Library

    Returns a list of matching records by searching through file metadata. By default, if no specific fields are specified, it searches across "owner", "filename", "headers", and "note". You can specify which fields to search through by including them in the request. This search does not examine file content.

    POST /library/search

  • Read

    Shared files at root

    GET /library/shared-with-me/

    GET /library/shared-with-me/

  • Read

    Shared files in dir

    Returns all files with permissions shared with user in the given location. The files returned are limited to the requested directory and will not return nested files at any deeper directory level.

    GET /library/shared-with-me/{handle}

  • Read

    Shared with my team files at root

    Returns all files shared with user's team at root level.

    GET /library/shared-with-my-team/

  • Read

    Shared with my team files in dir

    Returns all files shared with user's team in the given location.

    GET /library/shared-with-my-team/{handle}

  • Read

    Datasets in dir

    Returns all library files with file permissions in the given location owned by the user making the request. The library files returned are limited to the requested directory and will not return nested files at any deeper directory level.

    GET /library/{handle}

  • Read

    Get enrichment credits

    Get current user's enrichment credit information.

    GET /user/enrichment-credits

  • Read

    Get space used

    Get the amount of space used by the current user

    GET /user/space-used

  • Write

    Save current view

    This endpoint returns a Json response acknowledging if the request to save the file was successful.

    POST /dataset/{handle}/save-current-view

  • Write

    Create view

    Creates a view with the provided name, and based on the specified client state version.

    POST /dataset/{handle}/views

  • Write

    Refresh linked sheets

    Recomputes the column metadata of every linked sheet created from this sheet's views synchronously, then recomputes their row counts in the background. Returns 202 as soon as the column metadata is written; the row counts are best effort and are not reflected in the response.

    POST /dataset/{handle}/views/refresh-linked-sheets

  • Write

    Update view

    Updates the client state of the specified view.

    PATCH /dataset/{handle}/views/{view}

  • Write

    Create linked sheet

    Creates a linked sheet with the provided name, and based on the specified view.

    POST /dataset/{handle}/views/{view}/as-linked-sheet

  • Write

    Create federated table

    Creates a federated table that queries all rows across the given member sheets without copying them. Members must share the same columns with compatible types and live on the same node.

    POST /federated

  • Write

    Copy file

    This endpoint returns a Json response acknowledging if the request to copy a file was successful.

    POST /file/{handle}/copy

  • Write

    Create an empty file

    Create an empty file in your Library.

    POST /files/blank

  • Write

    Combine files

    Combine files together into a new file. Column names and types must match. An in-place combine still writing after 15 seconds answers 202 and keeps running; poll the first file's operation status for its outcome.

    POST /files/combine

  • Write

    Combine files by name

    Combine files together into a new file using column header names.

    POST /files/combine/by-name

  • Write

    Create folder

    Create a new folder in your Library.

    POST /files/create

  • Write

    Create folder

    Create a new folder in your Library.

    POST /files/directory

  • Write

    Rename file

    POST /rename/{handle}

    POST /rename/{handle}

  • Destructive

    Set aggregate filter model

    Set aggregate filter model in the client state of a sheet.

    PUT /client-state/{handle}/aggregate-filter-model

  • Destructive

    Set aggregations

    Set aggregations in the client state of a sheet.

    PUT /client-state/{handle}/aggregations

  • Destructive

    Set column state

    Set column state in the client state of a sheet.

    PUT /client-state/{handle}/column-state

  • Destructive

    Set filter model

    Set filter model in the client state of a sheet.

    PUT /client-state/{handle}/filter-model

  • Destructive

    Set group columns

    Set group columns in the client state of a sheet.

    PUT /client-state/{handle}/group-columns

  • Destructive

    Reset client state

    Reset the client state of a sheet to the default state.

    PUT /client-state/{handle}/reset

  • Destructive

    Set sort model

    Set sort model in the client state of a sheet.

    PUT /client-state/{handle}/sort-model

  • Destructive

    Set visible columns

    Set visible columns in the client state of a sheet.

    PUT /client-state/{handle}/visible-columns

  • Destructive

    Set client state

    Sets the client state of a sheet given the client state string.

    PUT /dataset/{handle}/clientstate

  • Destructive

    Set client state by version id

    Sets the client state of a sheet to the specified version.

    PUT /dataset/{handle}/clientstate/{version}

  • Destructive

    Sets a file's note with a max length of 20K characters

    This endpoint returns a Json response acknowledging if the request to set a file's note was successful.

    PUT /dataset/{handle}/note

  • Destructive

    Delete view

    Deletes the specified view.

    DELETE /dataset/{handle}/views/{view}

  • Destructive

    Move file or folder

    Move a file or folder into a folder or to the root of your Library. Folder must already exist and it is forbidden to create a directory loop.

    PUT /file/{handle}/directory

Filter

  • Read

    Get filtered group count

    Returns the number of groups matching certain criteria.

    POST /dataset/{handle}/count/groups

  • Read

    Get filtered data row count

    Returns the number of rows matching certain criteria. The request object has many fields controlling which rows are returned. For basic filtering the only one that needs to be specified is the filterModel field. For more on constructing filters, see the Filter Model Detail Guide.

    POST /dataset/{handle}/count/rows

  • Read

    List saved filters

    GET /filter-templates

    GET /filter-templates

  • Read

    Describe saved filter

    GET /filter-templates/{filter-handle}

    GET /filter-templates/{filter-handle}

  • Read

    Get filter model for saved filter

    For the given saved filter, get an actual filter model as applied to the given sheet. That filter model can then be used to get filtered data. For more in filters, see the Filter Model Detail Guide.

    GET /filter-templates/{filter-handle}/on-sheet/{handle}

  • Write

    Filter data

    Returns rows matching certain criteria. The request object has many fields controlling which rows are returned. For basic filtering the only one that needs to be specified is the filterModel field. For more on constructing filters, see the Filter Model Detail Guide.

    POST /file/{handle}/filter

  • Write

    Filter data

    Returns rows matching certain criteria. Uses column names rather than ids and has restrictions on filters. See the Filter Model Detail Guide. Warning! This endpoint supports a subset of /filter.

    POST /file/{handle}/filter/by-name

  • Write

    Filter data with streaming progress

    Returns a server‐sent events (SSE) stream. Emits “progress” events with the number of rows and bytes processed, and finally a “data” event containing the filtered result, or an “error” event if something goes wrong.

    POST /file/{handle}/filter/stream-progress

  • Write

    Row number in filter result

    Get the row number in the filtered result set for the given unfiltered row number

    POST /file/{handle}/filter/{sheet-row-nr}

  • Destructive

    Create or update saved filter

    This requires a Filter Model, which is described in more detail in the Filter Model Detail Guide.

    PUT /filter-templates/{filter-handle}

  • Destructive

    Delete saved filter

    DELETE /filter-templates/{filter-handle}

    DELETE /filter-templates/{filter-handle}

Export

  • Read

    Download export

    After calling "Create export", take the handle it returns and wait for the job to finish, indicated by the state "processed". Then call this endpoint to get a presigned S3 URL. Download that URL to obtain the export file itself, which is a zip containing a csv file of your exported data.

    GET /dataset/{handle}/download-export

  • Write

    Create export

    This will queue an export for the given sheet and return immediately with the handle for the export. The handle can be used with the "Download export" endpoint.

    POST /dataset/{handle}/export

  • Write

    Creates and saves a file state so as to also contain any applied filters and grouping

    This endpoint returns a Json response acknowledging if the request to save the exported file was successful.

    POST /file/{handle}/save-exported

Share

  • Read

    Get organization permissions for file

    Returns organization file permissions for a file. Will only return permissions for the same organization that the requester is a member of

    GET /dataset/{handle}/organization-permissions

  • Write

    Request access to a file

    This endpoint returns a JSON response acknowledging if the request to send requesting access email to the owner was successful.

    POST /request-access/{handle}

  • Destructive

    Set organization permissions on file

    Permissions set on a file will apply to all members of the organization that the requesting user is a member of

    PUT /dataset/{handle}/organization-permissions

  • Destructive

    Share a file with others

    This endpoint will share access to a file with other users

    PUT /file/{handle}/share/file

  • Destructive

    Opt out of file that has been shared with you

    This endpoint will remove user files access on a shared file

    PUT /file/{handle}/share/opt-out

Audit

  • Read

    Get action history

    Get the list of write actions on the given sheet.

    GET /datasets/{handle}/activity

  • Read

    Search action history

    Search the list of write actions on the given sheet.

    POST /datasets/{handle}/activity/search

  • Write

    Total activity count

    Get total activity count on the given sheet.

    POST /datasets/{handle}/activity/count

Data cleanup

  • Read

    Count duplicated rows

    Counts how many duplicates will be removed and how many rows remain when deduplicating

    POST /datasets/{handle}/deduplicate-rows-count

  • Destructive

    Delete duplicated rows

    Deletes the duplicated rows based on the given columns and sort model

    DELETE /datasets/{handle}/deduplicate-rows

Enrich

  • Read

    Lists active enrichment tasks.

    Lists active enrichment tasks by user (default) or by sheet id.

    GET /enrich/user-defined-http/tasks

  • Read

    Preview of a generic HTTP enrichment

    Returns a preview of the generic HTTP enrichment based on provided request parameters.

    POST /enrich/user-defined-http/{handle}/preview

  • Read

    Get status for the given generic enrichment task.

    GET /enrich/user-defined-http/{task-handle}

    GET /enrich/user-defined-http/{task-handle}

  • Write

    Enrich data

    We offer multiple enrichment services, including built in enrichments for email validation, IP geolocation. We also support a number of enrichment providers where you supply your own API key for their service. Running an enrichment adds columns to your data.

    POST /enrich/email-abstract-api/{handle}/{col}

  • Write

    Enrich data

    We offer multiple enrichment services, including built in enrichments for email validation, IP geolocation. We also support a number of enrichment providers where you supply your own API key for their service. Running an enrichment adds columns to your data.

    POST /enrich/email-format-check/{handle}/{col}

  • Write

    Enrich data

    We offer multiple enrichment services, including built in enrichments for email validation, IP geolocation. We also support a number of enrichment providers where you supply your own API key for their service. Running an enrichment adds columns to your data.

    POST /enrich/geo/{handle}/{col}

  • Write

    Enrich data on demand

    Enrich a column using an enrichment that runs right away, not batched. Available enrichments are: revenuebase-linkedin, revenuebase-email

    POST /enrich/on-demand/{enrichment}/{handle}/{col}

  • Write

    Apply generic HTTP enrichment

    Applies a generic HTTP enrichment based on provided request parameters.

    POST /enrich/user-defined-http/{handle}/apply

  • Write

    Calculate expected credits used by the enrichment

    Returns the expected credits used by the generic HTTP enrichment based on provided request parameters.

    POST /enrich/user-defined-http/{handle}/expected-credits-used

  • Write

    Cancels the given enrichment task.

    Cancels the given task. No partial results will be added to the source table.

    POST /enrich/user-defined-http/{task-handle}/cancel

User

  • Read

    Detailed user info

    This endpoint returns the logged in user details.

    GET /user/details

  • Read

    User metadata

    Returns user metadata.

    GET /user/metadata

  • Read

    User info

    This endpoint returns the username of the authorization on the request and a boolean value for whether the request is authenticated. The username will be empty string if the request is anonymous, meaning it had no API key header. An invalid API key will produce a 401 error.

    GET /user/whoami

  • Read

    Get users autofill info

    Get user autofill info for other users that you are connected with. Use query parameters to specify which users to include.

    GET /users/autofill

  • Write

    Request access to Gigasheet API

    This endpoint sends an email to sales@gigasheet.com with subject “Request API key” saying “User X clicked button to request API key at time Y” where X is the logged-in user and Y is the the current time.

    POST /request-api-access

  • Write

    Sends an email invitation to the list of email addresses to join the Gigasheet

    This endpoint returns a JSON response acknowledging if the request to send an invitation email to the list of email addresses was successful.

    POST /send-invite

  • Write

    Request account deletion.

    Requests account deletion for the requesting user. Unlike other API endpoints, this endpoint cannot be authenticated using an API token, it must be authenticated using the interactive login flow.

    POST /user/account/deletion-request

  • Write

    Issue API key

    This endpoint creates a Gigasheet API token from an Auth0 consent code. Unlike other API endpoints, this endpoint cannot itself be authenticated using an API token, it must be authenticated using the interactive login flow. To create an API token, follow the Getting Started documentation.

    POST /user/api-token/create

  • Write

    Updates user metadata

    Updates user metadata with given settings. Only fields that are set will be updated.

    PATCH /user/metadata

  • Write

    Trigger password reset for requestor.

    Sends a password reset email to the requesting user.

    POST /user/reset-password

  • Destructive

    Delete account.

    Deletes account for the requesting user. Unlike other API endpoints, this endpoint cannot be authenticated using an API token, it must be authenticated using the interactive login flow.

    DELETE /user/account/{deletion-token}

  • Destructive

    Revoke API keys

    This endpoint revokes all Gigasheet API keys of the user signing this request. Use this to clean up keys you no longer need before issuing a new key.

    DELETE /user/api-token/all

  • Destructive

    Remove user from the team

    Remove the logged in used from the team.

    POST /user/remove-from-team

Tic

  • Read

    Get plans an NPI has rates for

    Lists the plans the given NPI has negotiated rates for in the given rate sheet, as one row per distinct payer and plan pair. Takes no query parameters: an NPI and a sheet in, every plan in that sheet for that NPI out. The sheet may be a linked sheet, in which case only the rows that sheet shows are considered. A malformed NPI is a 400, but a well-formed NPI the sheet holds no rates for is a 200 with an empty plans list - that is a successful answer, not an error, and it does not distinguish an NPI that does not exist from one with no rates in this sheet.

    GET /tic/{handle}/npi/{npi}/plans

Ticintel

  • Read

    Get public NPI profile

    Returns public profile information for the given NPI, excluding detailed contracted rates.

    GET /ticintel/npi/{npi}/public

Upload

  • Write

    Raw data direct upload

    POST /upload/direct

    POST /upload/direct

  • Write

    Upload from URL

    Upload to Gigasheet from the given url, optionally specifying file name and parent directory. Gigasheet will run the normal parsing flow and create multiple entries if appropriate.

    POST /upload/url

See How connections work for access and permissions, or browse all integrations.