Beta

アクセスリンク一覧

GEThttps://api.youvico.com/api/projects/:id/access-links
レート制限
Default
スコープ
access-links:read
プロジェクトロール
所有者管理者

プロジェクトのアクセスリンク一覧を取得します。

注意

accessKey は、APIキーまたは連携に access-links:read.key スコープがある場合にのみ返され、ない場合は null です。

例

curl 'https://api.youvico.com/api/projects/bdbff5de-96d7-468f-9db0-85fe28bd6b62/access-links' \
  -H 'Authorization: Bearer YOUR_API_KEY'
{
  "data": [
    {
      "id": "5e0c7a92-1d4b-4f3a-8c6e-2b9d0f1a7e34",
      "accessKey": "xopa.A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6",
      "description": "Client review",
      "role": "PROJECT_REVIEWER",
      "createdAt": "2026-04-11 02:30:15.402817"
    }
  ]
}
リクエスト
curl -X GET 'https://api.youvico.com/api/projects/bdbff5de-96d7-468f-9db0-85fe28bd6b62/access-links' \
-H 'Authorization: Bearer YOUR_API_KEY'
レスポンス200 OK
{
  "data": [
    {
      "id": "5e0c7a92-1d4b-4f3a-8c6e-2b9d0f1a7e34",
      "accessKey": "xopa.A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6",
      "description": "Client review",
      "role": "PROJECT_REVIEWER",
      "createdAt": "2026-04-11 02:30:15.402817"
    }
  ]
}

リクエスト

パス

idstringrequired
プロジェクトID

レスポンス

200 OK を返します。

dataarray
アクセスリンク
data[].idstring
アクセスリンクID

例: 5e0c7a92-1d4b-4f3a-8c6e-2b9d0f1a7e34

data[].accessKeystring?
アクセスキー

例: xopa.A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6

data[].descriptionstring?
アクセスリンクの説明

例: Client review

data[].rolestring
リンクで付与するプロジェクトロール

指定できる値: PROJECT_MEMBERPROJECT_REVIEWERPROJECT_RESTRICTED_REVIEWER

例: PROJECT_REVIEWER

data[].createdAtstring
アクセスリンク作成日時

例: 2026-04-11 02:30:15.402817