API Introduction

Start building with the HeyGov API

This reference is your key to a comprehensive understanding of the HeyGov API.

Integrations use the API to access a jurisdiction's departments, forms, payments and users. Integrations can connect services to HeyGov and build interactive experiences.

The base URL to send all API requests is https://api.heygov.com.

• Each HeyGov jurisdiction is identified by a unique ID as first path of API endpoint:

# URL format
https://api.heygov.com/{jurisdiction_id}

# HeyGov test jurisdiction
https://api.heygov.com/heyville.org

• HTTPS is required for all API requests.

• The API follows RESTful conventions when possible, with most operations performed via GET, POST, PATCH, and DELETE requests on page and database resources. Request and response bodies are encoded as JSON.