Public Access Links

Listing all Links

Changed on

This will list every Public Access Link upon this Form.

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.

get/v1/projects/{projectId}/forms/{xmlFormId}/public-links

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/public-links
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Response

This is the Extended Metadata response, if requested via the appropriate header:

createdAtstring required

ISO date format

displayNamestring required

All Actors, regardless of type, have a display name

idnumber required
type'user' | 'field_key' | 'public_link' | 'singleUse' required

The type of actor

updatedAtstring

ISO date format

deletedAtstring

ISO date format

tokenstring

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.

onceboolean

If set to true, an Enketo single submission survey will be created instead of a standard one, limiting respondents to a single submission each.

Example response

[
  {
    "createdAt": "2018-04-18T23:19:14.802Z",
    "displayName": "My Display Name",
    "id": 115,
    "updatedAt": "2018-04-18T23:42:11.406Z",
    "deletedAt": "2018-04-18T23:42:11.406Z",
    "token": "d1!E2GVHgpr4h9bpxxtqUJ7EVJ1Q$Dusm2RBXg8XyVJMCBCbvyE8cGacxUx3bcUT"
  }
]

Changes