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

# folk CRM

> Connect folk to track contact, company, and deal-pipeline KPIs in Ciclo — and link live deals to your Actions.

## Overview

[folk](https://folk.app) is a relationship-first CRM for managing contacts, companies, and
deal pipelines. Connecting folk to Ciclo brings that pipeline data into your strategy in two
ways:

<CardGroup cols={2}>
  <Card title="Live KPIs" icon="chart-line">
    Turn folk data — total contacts, new companies, pipeline value, deals won —
    into [KPIs](/features/performance-kpis) that refresh automatically and sit
    alongside the rest of your strategy.
  </Card>

  <Card title="Deals as Actions" icon="square-check">
    Link a folk deal to an [Action](/features/actions) so the work to close it
    lives on your board — and moves to **Done** automatically when the deal
    closes in folk.
  </Card>
</CardGroup>

Once connected, the sync is one-way (folk → Ciclo): Ciclo reads your folk data to populate
KPIs and update linked Actions. It never writes back to or changes anything in folk.

<Note>
  folk uses a single **workspace-level API key** rather than a per-user login,
  so the key grants access to the whole folk workspace. For that reason,
  connecting and configuring folk is limited to **organisation administrators**.
</Note>

## Before you start

* You need an **administrator** role in Ciclo (the **Connect** and **Configure** buttons are
  disabled for everyone else).
* You need a folk account with permission to create an **API key** in your folk workspace.

## Connect folk

folk connects with an API key — there's no pop-up login like other integrations. You create
a key inside folk, then paste it into Ciclo once.

<Steps>
  <Step title="Open Connected Apps">
    Go to **Settings** from the account menu, then open the **Connected Apps**
    tab. Find **folk** in the list of available applications and select
    **Connect**.

    <Frame caption="folk in the Connected Apps list">
      <img src="https://mintcdn.com/ciclostrategy-5e0b62a7/H8jxLx4Wa2MCIXsS/images/integrations/connected-apps.png?fit=max&auto=format&n=H8jxLx4Wa2MCIXsS&q=85&s=d569ed0ea96c5d00de2477b8d93e0f91" alt="The folk row in the Connected Apps settings tab" width="1400" height="880" data-path="images/integrations/connected-apps.png" />
    </Frame>
  </Step>

  <Step title="Create an API key in folk">
    In the dialog that appears, select **Get your API key →**. This opens folk's
    API key settings for your workspace. Create a new key and copy it. (In folk
    you can also reach this from **Settings → API keys**.)

    <Frame caption="Creating an API key in folk">
      <img src="https://mintcdn.com/ciclostrategy-5e0b62a7/xst0q8VQ171r6I_e/images/integrations/folk/folk-api-keys.png?fit=max&auto=format&n=xst0q8VQ171r6I_e&q=85&s=65e9f7faef83f540ca1f6ed3b968ab91" alt="The API keys settings page inside folk" width="1400" height="1040" data-path="images/integrations/folk/folk-api-keys.png" />
    </Frame>
  </Step>

  <Step title="Paste the key into Ciclo">
    Back in Ciclo, paste the key into the **API key** field and select
    **Connect**. Ciclo validates the key with folk and stores it securely — the
    key is encrypted and never shown again.

    <Frame caption="Pasting your folk API key into Ciclo">
      <img src="https://mintcdn.com/ciclostrategy-5e0b62a7/xst0q8VQ171r6I_e/images/integrations/folk/api-key-modal.png?fit=max&auto=format&n=xst0q8VQ171r6I_e&q=85&s=aa5a5976eca1ee908b14e3077a8ccb23" alt="The Connect folk dialog with the API key field" width="1400" height="1061" data-path="images/integrations/folk/api-key-modal.png" />
    </Frame>
  </Step>

  <Step title="Confirm the connection">
    On success, folk shows a green **Connected** status in the list. You're
    ready to add KPIs and link deals.
  </Step>
</Steps>

<Tip>
  Treat the API key like a password. If it's ever exposed, revoke it in folk and
  reconnect with a fresh key — your KPIs and linked Actions reconnect
  automatically.
</Tip>

## Track folk KPIs

KPIs are configured from the **Connected Apps** tab, then appear on your team's
[Performance page](/features/performance-kpis) and refresh on a schedule — no manual updates.

<Steps>
  <Step title="Open the folk configuration">
    On the **folk** row in Connected Apps, select **Configure**. This lists any
    folk KPIs you've already created.

    <Frame caption="The folk KPI configuration dialog">
      <img src="https://mintcdn.com/ciclostrategy-5e0b62a7/xst0q8VQ171r6I_e/images/integrations/folk/configure-kpi-list.png?fit=max&auto=format&n=xst0q8VQ171r6I_e&q=85&s=32c556b534a2df3f83d91e682ccecec5" alt="The folk KPI configuration dialog listing existing KPIs" width="1400" height="1061" data-path="images/integrations/folk/configure-kpi-list.png" />
    </Frame>
  </Step>

  <Step title="Add a new KPI">
    Select **Add New KPI** and give it a clear **KPI Name** (e.g. "New contacts
    this month").

    <Frame caption="Creating a new folk KPI">
      <img src="https://mintcdn.com/ciclostrategy-5e0b62a7/xst0q8VQ171r6I_e/images/integrations/folk/new-kpi.png?fit=max&auto=format&n=xst0q8VQ171r6I_e&q=85&s=a16df34814d7c46eab32b188a41bdcdd" alt="The Create New folk KPI form" width="1400" height="1061" data-path="images/integrations/folk/new-kpi.png" />
    </Frame>
  </Step>

  <Step title="Pick a template">
    Choose a **Query Template** as your starting point — see the [catalogue
    below](#available-folk-kpis). Workspace-wide templates (People, Companies)
    work immediately. Group and deal templates need you to pick a **Group**.
  </Step>

  <Step title="Choose a group (for group & deal KPIs)">
    If the template tracks a specific list or pipeline, select the folk
    **Group** it applies to. Ciclo resolves the group automatically — you just
    pick it by name.
  </Step>

  <Step title="Refine deal stage (optional)">
    For deal KPIs, a **Status** dropdown appears, populated with the real stages
    from your folk pipeline (e.g. *Qualified*, *Closed-won*). Pick the stage you
    want to measure — it updates the query for you.
  </Step>

  <Step title="Create the KPI">
    Select **Create KPI**. It now appears on your [Performance
    page](/features/performance-kpis) and refreshes automatically.

    <Frame caption="A folk KPI on the Performance page">
      <img src="https://mintcdn.com/ciclostrategy-5e0b62a7/xst0q8VQ171r6I_e/images/integrations/folk/kpi-on-performance.png?fit=max&auto=format&n=xst0q8VQ171r6I_e&q=85&s=6f1f74087c770c01c53449512862d8b1" alt="A folk-sourced KPI shown on the Performance page" width="1400" height="1061" data-path="images/integrations/folk/kpi-on-performance.png" />
    </Frame>
  </Step>
</Steps>

### Available folk KPIs

<AccordionGroup>
  <Accordion title="People (whole workspace)" icon="users">
    Count contacts across your entire folk workspace. - **Total People** — every
    contact in the workspace. - **New People (7 / 30 / 90 days)** — contacts
    added in the last week, month, or quarter.
  </Accordion>

  <Accordion title="Companies (whole workspace)" icon="building">
    Count companies across the workspace. - **Total Companies** — every company
    in the workspace. - **New Companies (30 days)** — companies added in the
    last month.
  </Accordion>

  <Accordion title="Group membership (needs a group)" icon="layer-group">
    Measure the size and growth of a specific folk group or list of contacts. -
    **Group Size (People)** — contacts in the selected group. - **People Added
    to Group (7 / 30 days)** — recent additions to the group.
  </Accordion>

  <Accordion title="Deals & pipeline (needs a deal group)" icon="handshake">
    Track a deal pipeline by stage and value. - **Open Deals** / **Deals in
    Stage** — count of deals at a chosen stage. - **Deals Won (7 / 30 days)** —
    deals closed-won in the period. - **Total Pipeline Value** — summed value of
    open deals. - **Won Revenue (30 days)** — summed value of deals won in the
    last month.
  </Accordion>
</AccordionGroup>

<Note>
  In folk, a deal's **stage** and **value** are custom fields, and stage names
  are specific to your workspace. That's why the stage dropdown reads the real
  options straight from your pipeline — so the KPI always matches how your team
  actually labels its deals.
</Note>

## Link folk deals to Actions

You can attach a live folk deal to an Action so the work to win it lives on your
[Actions board](/features/actions), with the deal's value, close date, owner, and contacts
carried across.

<Steps>
  <Step title="Open an action and go to Connect">
    Create or open an [Action](/features/actions), then choose the **Connect**
    option to link an external item.
  </Step>

  <Step title="Choose folk, then the group and deal">
    Select **folk** as the source, pick the **group** that holds your deals,
    then choose the **deal** to connect. Ciclo fills in the action's title, due
    date (the deal's close date), and details from the deal.

    <Frame caption="Linking a folk deal to an action">
      <img src="https://mintcdn.com/ciclostrategy-5e0b62a7/xst0q8VQ171r6I_e/images/integrations/folk/link-deal-action.png?fit=max&auto=format&n=xst0q8VQ171r6I_e&q=85&s=fedf64f89ab06843d9c5cd28c3c47f11" alt="Selecting a folk group and deal to connect to an action" width="1400" height="1061" data-path="images/integrations/folk/link-deal-action.png" />
    </Frame>
  </Step>

  <Step title="Save the action">
    Save, and the action stays connected to the deal.
  </Step>
</Steps>

<Note>
  **Automatic status sync.** When a connected deal is marked **closed** in folk,
  Ciclo moves the linked action to **Done** on your board — so closing the deal
  in your CRM keeps your strategy board honest without any extra clicks.
</Note>

## Customising a KPI (optional)

You don't need any of this to get great results — the built-in templates are designed to be
accurate on their own. Pick a template (and a group/stage where prompted) and you're done.
Expand the sections below only if you want to fine-tune or go further.

<AccordionGroup>
  <Accordion title="Tweak a template to fit" icon="sliders">
    If a template is close but not quite right, you can adjust it instead of starting from
    scratch. Every KPI has an editable **Query** field — for example, change the window from
    the last 30 days to the last 14 days by editing `{date-30d}` to `{date-14d}`, or pick a
    different pipeline stage from the dropdown. The templates and dropdowns simply fill this
    field in for you; editing it is optional.
  </Accordion>

  <Accordion title="Write your own query" icon="code">
    Power users can replace the query entirely using folk's own API path and filter syntax —
    anything folk's API supports, you can track. For everything that's possible, see:

    <Card title="folk API reference" icon="address-book" href="https://developer.folk.app/api-reference">
      The full set of folk endpoints and filters you can use in a query.
    </Card>

    <Warning>
      One thing to watch when hand-editing: folk silently ignores an unrecognised stage value
      and returns **all** records instead of erroring, which would quietly inflate a KPI. When
      in doubt, use the stage dropdown — it always produces a correct query.
    </Warning>
  </Accordion>
</AccordionGroup>

## Disconnecting folk

To disconnect, select **Disconnect** on the folk row in Connected Apps. Ciclo shows which
KPIs and Actions rely on folk before you confirm.

<Note>
  Disconnecting **preserves history** — your KPIs keep their recorded values and
  linked Actions keep their data. They simply stop syncing until you reconnect,
  at which point they pick up automatically.
</Note>

## Best practices

* **Track what's strategic** — connect the few pipeline metrics that map to a goal, not every
  possible count.
* **Match your stages** — use the stage dropdown so KPIs follow how your team labels deals.
* **Link key deals** — connect significant deals to Actions so the work to close them is
  visible and accountable.
* **Keep the key safe** — rotate the API key in folk if it's ever exposed, then reconnect.

## Related

<CardGroup cols={2}>
  <Card title="Integrations overview" icon="plug" href="/integrations/overview" />

  <Card title="Performance & KPIs" icon="chart-line" href="/features/performance-kpis" />

  <Card title="Actions" icon="square-check" href="/features/actions" />

  <Card title="Connected Apps in Settings" icon="gear" href="/features/admin-settings" />
</CardGroup>
