# Gridly

This page contains the setup guide and reference information for the Gridly source connector.

## Prerequisites

A Gridly account.

## Setup guide

### Get api Key
1. To quickly get your API key, access your Gridly Dashboard, then select a Grid View and you can find the key in API quick start right panel.
![img.png](../../.gitbook/assets/gridly_api_key1.png)
2. Owner and Administrators can go to Settings/API keys to create company-level API keys with scoped privileges and accesses.
![img.png](../../.gitbook/assets/gridly_api_key2.png)

### Get grid id
The grid id is available in the url.
Gridly support version control, by default the `grid id` is the same to the `branch id` when `Master` branch is selected. For fetching records on other branches, use `branch id` instead.
![img.png](../../.gitbook/assets/gridly_grid_id.png)


## Supported sync modes

| Feature                       | Supported? |
| :---------------------------- |:-----------|
| Full Refresh Sync             | Yes        |
| Incremental Sync              | No         |


## Supported Streams

* [Records](https://www.gridly.com/docs/api/#record)

## Changelog