Get Started with Synqly

Get up and running with Synqly in just a few minutes.

In this tutorial, you will:

• Generate an Organization Access Token
• Create a test account
• Create an integration using Synqly Labs
• Make your first Synqly API request

By the end of this guide, you will have a working integration and be able to query data from Synqly APIs.

Make sure you have:

• Accepted your Synqly organization invitation
• Access to the Synqly Management Console

Your Organization Access Token is used to authenticate Management API requests.

1. Sign in to the Synqly Management Console
2. Navigate to Settings → API Keys
3. Generate a Primary Access Token
4. Store the token securely, you will need it later

→ Learn more: Organization Access Tokens

Create a Test Account that will own your integrations.

Run the following request using the Organization Access Token generated in Step 1.

curl -i -X POST \
  https://api.synqly.com/v1/accounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

A successful response returns an account object similar to the following:

{
  "result": {
    "account": {
      "name": "~8a940e4c-1252-4569-bc82-542bb490c8bc",
      "id": "8a940e4c-1252-4569-bc82-542bb490c8bc",
      "fullname": "~8a940e4c-1252-4569-bc82-542bb490c8bc",
      "organization_id": "7f643487-0b9e-4721-92be-ae0470eda8ee",
      "environment": "test",
      "created_at": "2026-05-26T09:51:46.929847Z",
      "updated_at": "2026-05-26T09:51:46.929847Z"
    }
  }
}

Save the following value from the response:

• result.account.id

You will use this Account ID in the next step.

→ Learn more: Accounts

Synqly Labs acts like a provider's API. It returns sample data, such as EDR endpoints and applications, so you can try Synqly without a live provider. You can use it to:

• Create an integration without an actual provider account
• Test API requests without changing data in a real tenant
• Skip provider authentication, because Labs accepts any credential value

In this example, you will create an EDR integration with the edr_crowdstrike provider, the same provider you would use for a real CrowdStrike tenant. Set url to the CrowdStrike Labs URL, synqly://labs/crowdstrike. The credential can have any value, but it must be an OAuth client ID and secret.

curl -i -X POST \
  'https://api.synqly.com/v1/integrations/{accountId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "provider_config": {
      "credential": {
        "access_key_id": "string",
        "secret_access_key": "pa$$word"
      },
      "region": "us-east-1"
    }
  }'

A successful response returns:

• An Integration ID
• An Integration Access Token

Example response:

{
  "result": {
    "credentials_created": [
      { … }
    ],
    "integration": {
      "name": "aa42f9fb-c32b-476d-9975-1099d1ab22e8",
      "id": "aa42f9fb-c32b-476d-9975-1099d1ab22e8",
      "fullname": "aa42f9fb-c32b-476d-9975-1099d1ab22e8",
      "refresh_token_id": "b4ac267b-e216-43cb-b748-153b1b7c6d66",
      "account_id": "8a940e4c-1252-4569-bc82-542bb490c8bc",
      "category": "edr",
      "provider_config": { … },
      "provider_fullname": "CrowdStrike Insight EDR",
      "provider_type": "crowdstrike",
      "created_at": "2026-11-12T05:44:55.128695Z",
      "updated_at": "2026-11-12T05:44:55.128695Z"
    },
    "token": {
      "access": { … },
      "refresh": { … }
    }
  }
}

Save the following values from the response:

• result.integration.id
• result.token.access.secret

You will use the Integration Access Token to call Connector APIs.

→ Learn more: Integrations · Synqly Labs · CrowdStrike on Labs

You are now ready to make API requests using your Integration Access Token.

Since this tutorial uses the edr_crowdstrike provider, the integration exposes data models related to the EDR (Endpoint Detection and Response) category.

In the following examples, you will query:

• EDR Endpoints
• EDR Applications

These APIs return sample EDR data from Synqly Labs, allowing you to explore the connector experience without connecting to a real CrowdStrike environment.

curl -i -X GET \
  https://api.synqly.com/v1/edr/endpoints \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

curl -i -X GET \
  https://api.synqly.com/v1/edr/applications \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

You should receive sample CrowdStrike EDR response data from Synqly Labs related to endpoints and applications.

→ Learn more: Connectors · EDR Connector

In four steps, you built a working Synqly integration. You now have:

• An Organization Access Token for creating and managing resources.
• A test Account that stands in for one of your customers.
• An EDR Integration connected to CrowdStrike on Synqly Labs, with its own Integration Access Token.
• Results from GET /v1/edr/endpoints and GET /v1/edr/applications, returned by the same Connector APIs you'll use in production.

To use a real CrowdStrike tenant, create the Integration with the real Base URL and credentials instead of the Labs URL. Your Connector API calls stay the same.

• Understanding the Synqly Model: why Synqly uses Accounts and two kinds of token
• API Tokens and Access Control: how token scopes limit what each access token can do

• Synqly SDKs: make the same calls from your own code
• API Reference: every Management and Connector API endpoint