リクエストとレスポンス
Base URL
すべてのエンドポイントは次のURLの下にあります。
https://api.youvico.com/apiヘッダー
| ヘッダー | 値 |
|---|---|
Authorization | Bearer YOUR_API_KEY |
Content-Type | application/json(ボディを持つリクエストの場合) |
リクエストボディ
APIはJSONを受け取り、JSONを返します。
- ページネーションを使う一覧エンドポイントは
QUERYメソッドを使用し、入力をボディで受け取ります。入力がない場合は{}を送信します。 - 別のリソースを指定するには、その
idを持つオブジェクトを送信します。
json
{
"folder": { "id": "DX1234567890ABCD" }
}レスポンスボディ
結果を返すレスポンスは、結果を data でラップします。
json
{
"data": {
"id": "bdbff5de-96d7-468f-9db0-85fe28bd6b62",
"name": "Launch Campaign"
}
}- ページネーションを使う一覧は
pageオブジェクトも返します。ページネーションを参照してください。 - 更新や削除など、何も返さないリクエストは
204 No Contentで応答します。 - 失敗したリクエストは
errorオブジェクトを返します。エラーを参照してください。
タイムスタンプ
タイムスタンプは YYYY-MM-DD HH:mm:ss[.ffffff] 形式のUTC文字列です(例: 2026-04-10 05:11:44.482913)。
フィールドの型
APIリファレンスのフィールド一覧では、次の表記を使用します。
| 表記 | 意味 |
|---|---|
string | 常にその型の値 |
string? | その型の値、または null |
required が付いたリクエストフィールドは必ず送信します。その他のリクエストフィールドは省略できます。