コンテンツにスキップ
Synqlet ヘルプ

API の概要

Synqlet は、外部のシステムから組織のデータを操作するための REST API を提供しています。

ベースURL

Section titled “ベースURL”

API のベースURLは https://api.synqlet.com です。

各エンドポイントは /api/<リソース名> の形式です（例: /api/flows、/api/api-keys）。利用できるエンドポイントの一覧は APIリファレンス を参照してください。

認証

Section titled “認証”

API へのリクエストには、HTTPヘッダー X-API-Key に APIキー を指定します。

X-API-Key: sk_synqlet_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

APIキーの発行方法は APIキーの発行 を参照してください。

リクエスト例

Section titled “リクエスト例”

例として、フローの一覧を取得してみます。curl などの HTTP クライアントから、X-API-Key ヘッダーに APIキーを指定して呼び出します。

ターミナルウィンドウ
curl https://api.synqlet.com/api/flows \
  -H "X-API-Key: sk_synqlet_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

成功すると、200 OK とともに次のような JSON が返ります（一部を省略しています）。

{
  "data": [
    {
      "id": "019e830e-3d06-7541-9c6c-bffe99d548f8",
      "name": "サンプル通知フロー",
      "organizationId": "0197bfe7-85da-7de7-b884-45c269f182b1",
      "runnerId": "019e830d-9808-74c8-9463-2f5280df5eba",
      "archived": false,
      "createdAt": "2026-06-01T12:00:08.959Z",
      "updatedAt": "2026-06-01T12:00:08.959Z"
    }
  ],
  "nextUrl": null
}

一覧系のエンドポイントは data（結果の配列）と nextUrl（次ページのURL）を返します。nextUrl が null でなければ、そのURLを呼び出すと続きを取得できます（Link ヘッダーにも同じURLが入ります）。件数は一覧には含まれないので、必要なときは GET /api/<リソース>/count で取得します。絞り込み・並び替え・ページングの詳細はAPI の使い方を参照してください。

認証に失敗した場合は 401 Unauthorized が返ります。X-API-Key ヘッダーが正しく設定されているか確認してください。

{ "message": "Invalid api key", "error": "Unauthorized", "statusCode": 401 }

次のステップ

Section titled “次のステップ”