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

# Quickstart

> Create a connector, sync it and make your first Bindbee API call.

## Prerequisites

* A Bindbee account. Access is provisioned during onboarding. If you don't have access, email [Bindbee Support](mailto:support@bindbee.dev).
* Your **Development API key** from [Bindbee Dashboard](https://app.bindbee.dev/settings/keys).

<Frame caption="Settings → API Key. Production and Development are separate keys, and neither works against the other's connectors.">
  <img src="https://mintcdn.com/unifyx-56/NU46D4mywOWu_9HZ/images/quickstart/api-keys.png?fit=max&auto=format&n=NU46D4mywOWu_9HZ&q=85&s=e9827d8a08e0a3ccbdc91a738510bd58" alt="The API Key settings page, showing a Production Key block and a Development Key block, each with a masked value and a Regenerate Key button" width="2420" height="796" data-path="images/quickstart/api-keys.png" />
</Frame>

***

## Steps

<Steps>
  <Step title="Open the Development tab">
    Go to [app.bindbee.dev](https://app.bindbee.dev), open **Connectors**, and switch to the **Development** tab.

    <Frame caption="Connectors → Development. The notice here is about recurring syncs - the first one still runs on its own.">
      <img src="https://mintcdn.com/unifyx-56/NU46D4mywOWu_9HZ/images/quickstart/connectors-development.png?fit=max&auto=format&n=NU46D4mywOWu_9HZ&q=85&s=5f5a006197faf3c89721cec45d61ebda" alt="The Connectors page on the Development tab, noting that development connectors do not sync automatically, with a Test Connector button" width="2290" height="314" data-path="images/quickstart/connectors-development.png" />
    </Frame>

    **Result:** You are on the tab test connectors are created from.
  </Step>

  <Step title="Create a test connector">
    Press **+ Test Connector**, then pick a category and an integration - for example **BambooHR** under HRIS.

    <Frame caption="Create Connector → Select integration. The Unique Customer ID is the `origin_id` you'll use to match this connector back to your own customer record.">
      <img src="https://mintcdn.com/unifyx-56/NU46D4mywOWu_9HZ/images/quickstart/select-integration.jpg?fit=max&auto=format&n=NU46D4mywOWu_9HZ&q=85&s=70c542d452827568768115a853f57ac2" alt="The Create Connector form with an Organisation Name field, a Categories dropdown set to HRIS and a Unique Customer ID field, beside the Select integration panel with API and SFTP tabs and BambooHR selected from the integration grid" width="1920" height="1080" data-path="images/quickstart/select-integration.jpg" />
    </Frame>

    **Result:** The form carries the Unique Customer ID that maps this connector back to your own customer record.
  </Step>

  <Step title="Authorize the connection">
    Follow the prompts to complete authorization.

    <Frame caption="The authorization screens your customer sees. Access is granted per data model, and which methods are offered depends on the integration.">
      <img src="https://mintcdn.com/unifyx-56/NU46D4mywOWu_9HZ/images/quickstart/test-connector-authentication.jpg?fit=max&auto=format&n=NU46D4mywOWu_9HZ&q=85&s=e81196b5950c561286a5d2f80c52e865" alt="A consent screen reading 'Bindbee is requesting access to BambooHR', listing data models including Benefit, Company, Compensation, Employee, Employment and Time Off with read access ticked and an Allow and Continue button, beside a 'How do you want to Authenticate?' panel offering OAuth Authentication marked Recommended or using your own API key" width="1920" height="1080" data-path="images/quickstart/test-connector-authentication.jpg" />
    </Frame>

    <Accordion icon="circle-question-mark" title="Need a third-party account?">
      It depends on the integration you pick. Some work with a demo account. Others need a real one - for BambooHR, a free [trial account](https://www.bamboohr.com/signup/h2) works.
    </Accordion>

    **Result:** The connector exists, and its initial sync has started.
  </Step>

  <Step title="Copy the connector token">
    Open the connector and copy the `connector_token` from the **Overview** tab.

    **Result:** You have the token that tells Bindbee whose data to return.
  </Step>

  <Step title="Wait for the first sync">
    The initial sync is a full read of every model in scope. It usually finishes in a couple of minutes.

    On the same **Overview** tab, watch the **Sync** panel until the run's **Status** reads **Synced**.

    <Frame caption="The connector's Sync panel. Wait for Status to read Synced before calling the API; Force Sync triggers the next run.">
      <img src="https://mintcdn.com/unifyx-56/NU46D4mywOWu_9HZ/images/quickstart/sync-panel.jpg?fit=max&auto=format&n=NU46D4mywOWu_9HZ&q=85&s=9fae10cc21c6c489d9e4f170e16c4620" alt="The Sync panel on a connector, listing sync #1 with trigger Automatic, status Synced, and the time it completed, alongside a Force Sync button" width="857" height="257" data-path="images/quickstart/sync-panel.jpg" />
    </Frame>

    <Note>
      **In Development, only the first sync runs on its own.** After that, press **Force Sync** or call [Force sync a connector](/api-reference/connectors/resync-connector) to get fresh data.
    </Note>

    **Result:** The run reads **Synced**, and the connector's data is ready to query.
  </Step>

  <Step title="Make your first API call">
    Send a `GET` request to the Employees endpoint:

    ```bash theme={null}
    curl https://api.bindbee.dev/api/hris/v1/employees \
      -H "Authorization: Bearer <BINDBEE_API_KEY>" \
      -H "X-Connector-Token: <CONNECTOR_TOKEN>"
    ```

    Every field the response can carry, with a sample payload, is on [Get Employees](/hris/employee/get-employees).

    **Result:** A `200` carrying employees, normalized out of that system.
  </Step>
</Steps>

***

## What just happened

1. You created a **connector** - one authorized connection to one source system.
2. You **synced** it, pulling that system's data into Bindbee.
3. You called the **Unified API** with your API key and the connector token, and got normalized data.

In production two things change: connectors sync on a schedule rather than on manual trigger, and your end users create them through Magic Link or Embedded SDK rather than you entering credentials. See [How to connect](/get-started/how-to-connect).

***

## Related

<CardGroup cols={2}>
  <Card title="Platform" icon="layout-dashboard" href="/get-started/platform">
    Magic Link, Connectors, Logs, Custom Fields, Webhooks and the Changelog - where each lives.
  </Card>

  <Card title="API basics" icon="square-terminal" href="/api-reference/basics/authentication">
    Authentication, pagination, rate limits and sync frequency.
  </Card>

  <Card title="Choose what to sync" icon="sliders-horizontal" href="/get-started/scoping">
    Narrow the models and fields Bindbee requests from every system.
  </Card>

  <Card title="Get notified on change" icon="webhook" href="/guides/reading-writing/webhooks">
    Subscribe to a webhook so your application stops polling.
  </Card>
</CardGroup>
