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

# Synq Quickstart: Make Your First API Call in Minutes

> Make your first authenticated Synq API call and retrieve your product catalog in just a few steps — no SDK or special tooling required.

The fastest way to explore Synq is through the REST API. This guide walks you from zero to your first successful API response: you'll grab a token, attach the required headers, and pull back a live list of products. The whole process takes under five minutes.

<Note>
  Every Synq API request requires three pieces of identifying information: a Bearer token, a **Tenant ID**, and an **Org ID**. Your Tenant ID and Org ID are provided when your account is provisioned. Keep them handy before you begin.
</Note>

<Steps>
  <Step title="Get your API token">
    Sign in to the [Synq Dashboard](https://app.synq.io) with your account credentials. Once signed in, open your account settings and copy your **API token** — this is the Bearer token you'll include on every API request.

    Tokens are short-lived, so retrieve a fresh one each time you start a new session. See the [Authentication guide](/authentication) for details on token expiry and how to refresh automatically.
  </Step>

  <Step title="Set your credentials as environment variables">
    Export your credentials as shell variables so you can reuse them in the examples below:

    ```bash theme={null}
    export SYNQ_TOKEN="your_api_token"
    export SYNQ_TENANT_ID="your_tenant_id"
    export SYNQ_ORG_ID="your_org_id"
    ```

    Your Tenant ID and Org ID are displayed in your account settings in the Synq Dashboard.
  </Step>

  <Step title="Make your first API call — list products">
    Send a `GET` request to the products endpoint. Include your token and the two required tenant headers:

    ```bash theme={null}
    curl -X GET https://api.synq.io/api/v1/pim/products \
      -H "Authorization: Bearer $SYNQ_TOKEN" \
      -H "X-Tenant-ID: $SYNQ_TENANT_ID" \
      -H "X-Org-ID: $SYNQ_ORG_ID"
    ```

    A successful response returns an array of product objects. Here's an example:

    ```json theme={null}
    {
      "data": [
        {
          "id": "prod_01HXKZ2J3VQNB8WTFM4RY5D6E",
          "name": "Classic Merino Crewneck",
          "sku": "MRN-CRW-NVY-L",
          "status": "active",
          "created_at": "2024-11-03T09:14:22Z"
        },
        {
          "id": "prod_01HXKZ5A7MPDC3RLWGE9TU2NF",
          "name": "Slim Chino Trousers",
          "sku": "CHN-SLM-KHK-32",
          "status": "active",
          "created_at": "2024-11-05T14:30:01Z"
        },
        {
          "id": "prod_01HXKZ8Q4YREH6SVXJBT0PW1C",
          "name": "Leather Oxford Shoes",
          "sku": "OXF-LTH-BLK-42",
          "status": "draft",
          "created_at": "2024-11-08T08:55:47Z"
        }
      ],
      "total": 3,
      "page": 1
    }
    ```
  </Step>

  <Step title="Explore further">
    You're connected. From here you can:

    * **Create a product** — `POST /api/v1/pim/products`
    * **Fetch a single product** — `GET /api/v1/pim/products/{id}`
    * **Check inventory levels** — `GET /api/v1/inventory`
    * **Place an order** — `POST /api/v1/oms/orders`

    Browse the full [API Reference](/api/overview) for every available endpoint, or follow the [Products Guide](/guides/products) for a deeper walkthrough of the PIM module.

    <Tip>
      Use a tool like [HTTPie](https://httpie.io/) or the [Bruno](https://www.usebruno.com/) API client to save your Synq environment variables and headers once — then every request is a single click.
    </Tip>
  </Step>
</Steps>
