メインコンテンツへスキップ
以下の規約は、個別のエンドポイントドキュメントに記載がない限り、すべての Teams OpenAPI エンドポイントに適用されます。

ベース URL

本番環境: https://api.qoder.com 完全な URL の例: https://api.qoder.com/v1/organizations/{organization_id}/members

フィールド命名規則

JSON は lowerCamelCase を使用します。例: organizationIdrepositoryUrlcreatedAtmaxResultsnextToken

タイムスタンプ

ISO 8601(RFC 3339) 形式を使用します。例:2025-01-01T00:00:00Z。一部のクエリパラメータは Unix ミリ秒タイムスタンプ も受け付けます—各エンドポイントを確認してください。

カーソルページネーション

リスト系エンドポイントは通常 カーソル ページネーションを使用します:

クエリパラメータ

パラメータ必須デフォルト説明
maxResultsintegerいいえ20ページサイズ、最大 100
nextTokenstringいいえ前回のレスポンスからのカーソル;最初のページでは省略
使用量エンドポイントでは、個別に記載がない限り nextToken をカーソルとして使用します。

レスポンスフィールド

フィールド説明
maxResultsintegerこのレスポンスで使用されたページサイズ
nextTokenstring次ページカーソル;空または省略はリスト終端
グローバルな totalCount に依存せず、カーソルが空になるまでページングしてください。

エラーレスポンス

失敗時、HTTP ステータスは非 2xx で、ボディはトップレベルの status フィールドを含まない JSON です。形式:

エラーオブジェクトフィールド

フィールド必須説明
requestIdstringはい関連 ID—サポートへの問い合わせ時に含めてください
codestringはいプログラム処理用の安定したコード
messagestringはい人間が読める概要
detailsarrayいいえオプションの追加コンテキスト

一般的な HTTP ステータスと code

HTTPcode意味
400BadRequest無効な入力
401UnauthorizedAPI キーが欠落または無効
403Forbiddenこの組織またはリソースへのアクセス不可
404NotFoundリソースが見つからない
409AlreadyExists競合
500InternalErrorサーバーエラー
ゲートウェイやサービスマッピング後、HTTP ステータスと code の組み合わせは実際のレスポンスで定義されます—ステータスだけに依存しないでください。

認証

以下を送信してください:
コンソールで作成したキーを使用します。実際のキーをパブリッククライアントやリポジトリに含めないでください。

組織パスプレフィックス

ほとんどのルートは以下を拡張します: /v1/organizations/{organization_id} organization_id はパスパラメータです。サブパスについては メンバー使用量AI コード指標 セクションを参照してください。