---
title: "Getting Link Details"
method: GET
path: "/v1/projects/{projectId}/forms/{xmlFormId}/public-links/{linkId}"
tags: ["Public Access Links"]
---

# Getting Link Details

`GET /v1/projects/{projectId}/forms/{xmlFormId}/public-links/{linkId}`

Returns the details of a single Public Access Link by its numeric ID.

This endpoint supports retrieving extended metadata; provide a header `X-Extended-Metadata: true` to additionally retrieve the Actor the Link was `createdBy` and a `properties` object containing any actor property values set on the Link.

## Path parameters

- `projectId` number, required
- `xmlFormId` string, required
- `linkId` integer, required

## Response `200`

OK

- PublicLink
  - `createdAt` string, required — ISO date format
  - `displayName` string, required — All `Actor`s, regardless of type, have a display name
  - `id` number, required
  - `type` 'user' | 'field_key' | 'public_link' | 'singleUse', required — The type of actor
  - `updatedAt` string — ISO date format
  - `deletedAt` string — ISO date format
  - `token` string — If present, this is the Token to include as the `st` query parameter for this `Public Link`. If not present, this `Public Link` has been revoked.
  - `once` boolean — If set to `true`, an Enketo [single submission survey](https://blog.enketo.org/single-submission-surveys/) will be created instead of a standard one, limiting respondents to a single submission each.

## Changes

- **2026-06-02** `dcd5409827e1` — 1 info
  - endpoint added
- **2025-03-13** `e8c2858fd4eb` — 1 breaking
  - api removed without deprecation

[Change history](https://skmtc.dev/getodk/apis/odk-central-api/changes/v1/projects/:projectId/forms/:xmlFormId/public-links/:linkId/get.md)

---

[API](https://skmtc.dev/getodk/apis/odk-central-api.md) · [All operations](https://skmtc.dev/getodk/apis/odk-central-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getodk/odk-central-api/revisions/dc3ccc706398/schema)