Skip to main content
Returns the prefilled checkout links attached to a form, paginated. Includes links created via this API and via the dashboard’s URL Builder — both write to the same underlying store.

​
Endpoint

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

​
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.

​
Query parameters

​
limit
integer
default:"50"
Maximum number of links to return per page. Range: 1–200.
​
cursor
string
Pagination token from the previous response’s nextCursor. Omit on the first request.
​
active
string
Filter by active status. One of true or false. Omit to include both.

​
Response

​
links
object[]
Array of link objects in the same shape as the Get Link response (without createdAt precision differences). Each includes linkID, formID, name, prefill, checkoutUrl, destinationType, overlayPath, active, createdAt.Note: when a link’s destinationType is OVERLAY_* but the organization’s organizationBaseURLs is unavailable, that row’s checkoutUrl will be null rather than a broken relative URL. The rest of the row is still returned so you can identify it and either re-configure the organization or delete the link.
​
nextCursor
string | null
Opaque pagination token. Pass back as ?cursor= to fetch the next page. null when there are no more pages.

​
Status codes

CodeDescription
200List returned (may be empty).
400Invalid limit or active query parameter.
401Missing or invalid API key.
403Form belongs to a different organization.
404No form found with the given ID.
500Internal error.

​
Examples

​
First page (default limit)

cURL
curl "https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/forms/{formID}/links" \
  -H "Authorization: Bearer cs_live_your_key"

​
Paginate through results

cURL
# First page
curl "https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/forms/{formID}/links?limit=20" \
  -H "Authorization: Bearer cs_live_your_key"

# Next page using the returned cursor
curl "https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/forms/{formID}/links?limit=20&cursor=eyJlbGVtZW50SUQ..." \
  -H "Authorization: Bearer cs_live_your_key"
cURL
curl "https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/forms/{formID}/links?active=false" \
  -H "Authorization: Bearer cs_live_your_key"
200 response 
{
  "links": [
    {
      "linkID": "bc033789-1ee2-4f3f-bec5-2f108c2d65ba",
      "formID": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Outreach email — May 2026",
      "prefill": {
        "firstName": "Akif",
        "email": "akif@example.org",
        "amount": "50",
        "frequency": "MONTHLY"
      },
      "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"
    }
  ],
  "nextCursor": null
}