> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Clarify

> Integrate your application with the Clarify API

## Quickstart

Connect to Clarify with Nango and see data flow in 2 minutes.

**1. Create the integration**

In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Clarify*.

**2. Authorize Clarify**

Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then enter your Clarify workspace slug (for example `acme`, not the full app URL) and API key. See the [connect guide](https://nango.dev/docs/api-integrations/clarify/connect) for where to find each value. Later, you'll let your users do the same directly from your app.

**3. Call the Clarify API**

Let's make your first request to the Clarify API (list workspace lists, one row). Replace the placeholders below with your [Environment API key](https://nango.dev/docs/reference/backend/http-api/api-keys.md), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

**cURL**

```bash theme={null}
curl --globoff "https://api.nango.dev/proxy/v1/workspaces/<WORKSPACE-SLUG>/lists?page[limit]=1" \
  -H "Authorization: Bearer <NANGO-API-KEY>" \
  -H "Provider-Config-Key: <INTEGRATION-ID>" \
  -H "Connection-Id: <CONNECTION-ID>"
```

**Node**

Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

```typescript theme={null}
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/v1/workspaces/<WORKSPACE-SLUG>/lists?page[limit]=1',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```

Or fetch credentials with the [Node SDK](https://nango.dev/docs/reference/backend/backend-sdk/node.md#get-a-connection-with-credentials) or [API](https://nango.dev/docs/reference/backend/http-api/connections/get.md).

You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.

**4. Implement Nango in your app**

Follow our [Auth implementation guide](https://nango.dev/docs/guides/primitives/auth.md) to integrate Nango in your app.

To obtain your own production credentials, follow the connect guide linked below.

## Clarify Integration Guides

Nango-maintained guides for common use cases.

* [How do I link my Clarify account?](https://nango.dev/docs/api-integrations/clarify/connect)\
  Obtain your workspace slug and API key, then connect through the Connect UI.

Official docs:

* [Clarify API introduction](https://developer.clarify.ai/docs)
* [List a workspace's lists](https://developer.clarify.ai/docs/api-reference/lists/getWorkspaceLists)

## Pre-built syncs & actions for Clarify

Enable them in your dashboard. Extend and customize to fit your needs.

### Others

| Function name | Description | Type | Source code |
| - | - | - | - |
| `get-list` | Fetch a single Clarify list by object type and list ID. | [Action](https://nango.dev/docs/guides/functions/action-functions.md) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clarify/actions/get-list.ts) |
| `list-list-resources` | List records that belong to a Clarify list. | [Action](https://nango.dev/docs/guides/functions/action-functions.md) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clarify/actions/list-list-resources.ts) |
| `list-lists` | List Clarify workspace lists across all object types. | [Action](https://nango.dev/docs/guides/functions/action-functions.md) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clarify/actions/list-lists.ts) |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.