Sign in
Public Access Links

Listing all Links

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

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

Changed in 3 of the 54 revisions of this API.13

  • dcd5409827e11See the full diff
    • ○

      added the optional property items/allOf[subschema #2]/properties to the response with the 200 status

      response-optional-property-added

  • 022694254f0d1See the full diff
    • ○

      api operation id Listing all Links removed and replaced with listAllLinks

      api-operation-id-removed

  • e8c2858fd4eb11See the full diff
    • ●

      removed the optional property items/allOf[subschema #2]/properties from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id listAllLinks removed and replaced with Listing all Links

      api-operation-id-removed

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog