Skip to main content
The Get Link endpoint returns a single prefilled checkout link by its ID. Use it to verify a link’s contents after creation, to retrieve a checkoutUrl you may have lost, or to inspect what’s stored before sharing. The link must belong to your organization and must be attached to the formID in the path — both are validated to keep the URL shape (/forms/{X}/links/{Y}) honest about parent ownership.

​
Endpoint

GET https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/forms/{formID}/links/{linkID}

​
Authentication

​
Authorization
string
required
Bearer token using your API key. Format: Bearer cs_live_your_key

​
Path parameters

​
formID
string
required
The parent form’s unique identifier.
​
linkID
string
required
The link’s unique identifier, returned by Create Link.

​
Response

​
linkID
string
Unique identifier for the link.
​
formID
string
The parent form’s ID.
​
name
string
The link’s internal label.
​
prefill
object
The prefill payload, translated back to the same camelCase keys you sent on create. Keys are omitted if they weren’t set. customInputs are keyed by their original question title (or the storage key as a fallback if the input was renamed/deleted on the form after the link was created). See Create Link — prefill whitelist for the full set.
​
checkoutUrl
string
The shareable URL. Rebuilt from current destinationType + overlayPath + organization config — so if the underlying form or merchant config changed, the URL reflects the current state.
​
destinationType
string
One of HOSTED_PAGE_DONATE, HOSTED_PAGE_ATTEND, OVERLAY_DONATE, OVERLAY_ATTEND.
​
overlayPath
string
URL path on the organization’s site (only set for OVERLAY_* destinations; empty string otherwise).
​
active
boolean
Whether the link is active. Inactive links are visible via List Links with ?active=false and can be re-enabled via Activate.
​
createdAt
string
ISO 8601 UTC timestamp from when the link was created.

​
Status codes

CodeDescription
200Link returned successfully.
400Missing formID or linkID path parameter.
401Missing or invalid API key.
403Link belongs to a different organization.
404No link found with the given ID, or the link isn’t attached to the supplied formID.
500Internal error (e.g. the link’s destinationType is overlay but the organization’s organizationBaseURLs is unavailable).

​
Example

cURL
curl https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/forms/550e8400-e29b-41d4-a716-446655440000/links/bc033789-1ee2-4f3f-bec5-2f108c2d65ba \
  -H "Authorization: Bearer cs_live_your_key"
200 response 
{
  "linkID": "bc033789-1ee2-4f3f-bec5-2f108c2d65ba",
  "formID": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Outreach email — May 2026",
  "prefill": {
    "firstName": "Akif",
    "lastName": "Abidi",
    "email": "akif@example.org",
    "amount": "50",
    "frequency": "MONTHLY",
    "customInputs": {
      "T-shirt size": "M"
    }
  },
  "checkoutUrl": "https://charitystack.com/donate/550e8400-e29b-41d4-a716-446655440000?elementid=bc033789-1ee2-4f3f-bec5-2f108c2d65ba",
  "destinationType": "HOSTED_PAGE_DONATE",
  "overlayPath": "",
  "active": true,
  "createdAt": "2026-05-22T10:41:23.651186+00:00"
}