API Reference
API reference · Public Links
GET
/public-links/{guid}
Get Public Link Details
Retrieve a public link's settings along with signer submission history and IP logs.
Authentication
This endpoint requires a bearer token. See Authentication and API Keys.
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | required | Bearer <BEARER_TOKEN> |
Parameters
| Parameter | Type | Description |
|---|---|---|
| guid required | string | Public link GUID (e.g. a4d3f5e2-6374-4b57-9d7a-1123456789ab). |
Request body
Request body: None.
Request example
curl -X GET "https://toolkit.undersign.app/api/v1.1/public-links/<link-guid>" \ -H "Authorization: Bearer <BEARER_TOKEN>"
Response
A successful response returns the link record with an embedded submissions list:
200 OK
{
"success": true,
"request_id": "...",
"timestamp": "...",
"data": {
"link_guid": "a4d3f5e2-6374-4b57-9d7a-1123456789ab",
"link_name": "Vendor Intake Form",
"status": "Active",
"submissions": [
{
"signer_name": "Sarah Miller",
"identity": "sarah@vendor.com",
"signed_at": "2026-09-17 15:10:00",
"ip": "198.51.100.42",
"status": "Completed",
"package_guid": "99B2A-3312E-182C0"
}
]
}
}
Response fields
| Field | Description |
|---|---|
| data.link_guid | Public link GUID. |
| data.link_name | Administrative name for the link. |
| data.status | Link status. |
| data.submissions | Signer submission history with IP logs. |
| submissions.signer_name | Submitting signer's name. |
| submissions.identity | Submitting signer's email or phone identity. |
| submissions.signed_at | When the submission was signed. |
| submissions.ip | Captured IP address, when IP capture is enabled. |
| submissions.status | Submission status. |
| submissions.package_guid | Package GUID created for the submission. Use it with Get Signature Request Status. |
Response status & error codes
| Code | Error code | Description |
|---|---|---|
200 OK |
- |
Link record with embedded submissions list. |
404 |
LINK_NOT_FOUND |
Link does not exist or belongs to another company. |
429 |
RATE_LIMIT_EXCEEDED |
Too many requests (limit: 100/min). See Rate Limits. |