Skip to main content

Public links

A public link lets a hospital, a jail intake desk, or an attorney read a warrant without an eCourtDate account. It is a deliberate publication step, not a default.

Publish​

curl -s -X PATCH "$BASE/warrants/$WARRANT_ID/visibility" \
  -H "x-api-key: $API_KEY" \
  -H "X-On-Behalf-Of: admin.reyes@example.gov" \
  -H "Content-Type: application/json" \
  -d '{"visibility": "PUBLIC"}'

The response carries the slug that identifies the link:

{"visibility": "PUBLIC", "slug": "ew-2026-004182-f3a91c"}

Only the applicant or an administrator can change visibility. Set "visibility": "PRIVATE" to unpublish; the link stops working immediately.

Read a published warrant​

curl -s "$BASE/warrants/public/ew-2026-004182-f3a91c"

No API key, no X-On-Behalf-Of. The response is a reduced view: the warrant number and status, the form contents the template publishes, the rendered document, the signing judge and time, the agency name, and the attachments.

Everything else is withheld: internal comments, the audit trail, applicant contact details, assignment history, and anything else that belongs to the workflow rather than to the warrant.

An application that is not PUBLIC returns 404, the same as a slug that never existed. The endpoint does not confirm that a private warrant exists.

Render the agency around it​

curl -s "$BASE/settings/public/travis-county-health"

Returns the agency's public identity: name, court name, address, timezone, contact number, and logo, so a public page can be branded correctly. The logo is served through GET /v1/public/branding/{fileId}, which also takes no key.

Before you publish anything​

A public link is a URL. Anyone who has it can read the warrant, and links get forwarded, pasted into tickets, and indexed if they end up on a public page. The slug is unguessable, and that is the whole of the access control.

  • Publish signed warrants, not drafts. A draft is not a court record.
  • Check what the template publishes before turning on public links for a warrant type that carries clinical detail.
  • Unpublish when the operational need has passed. PRIVATE takes effect at once.
  • Every visibility change is written to the audit trail, so who published a warrant and when is always answerable.