Beta

List Access Links

GEThttps://api.youvico.com/api/projects/:id/access-links
Rate Limit
Default
Project Role
OwnerManager

Returns a project's access links.

Warning

accessKey is returned only when the API key or connection has the access-links:read.key scope; otherwise it is null.

Example

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"
    }
  ]
}
Request
curl -X GET 'https://api.youvico.com/api/projects/bdbff5de-96d7-468f-9db0-85fe28bd6b62/access-links' \
-H 'Authorization: Bearer YOUR_API_KEY'
Response200 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"
    }
  ]
}

Request

Path

idstringrequired
Project ID

Response

Returns 200 OK.

dataarray
Access links
data[].idstring
Access link ID

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

data[].accessKeystring?
Access key

Example: xopa.A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6

data[].descriptionstring?
Access link description

Example: Client review

data[].rolestring
Project role granted by the link

Possible values: PROJECT_MEMBERPROJECT_REVIEWERPROJECT_RESTRICTED_REVIEWER

Example: PROJECT_REVIEWER

data[].createdAtstring
Access link creation date

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