Skip to main content

Site - Settings API

Overview

The API Settings page allows you to generate and manage your organization's API access key. The API key is used to authenticate requests made to the SeyGov API, allowing you to integrate your deployed applications with external systems, pull submission data programmatically, and build custom workflows on top of your data.

Generating an API Key

Click the Generate API Access Key button to create a new API bearer token for your organization. Once generated the token will be displayed on the page — copy it and store it in a secure location as it will be needed to authenticate all API requests.

Using Your API Key

To authenticate API requests include your token in the Authorization header of every request using the Bearer token format:

Authorization: Bearer your-token-here

All API requests must also include the following header:

Accept: application/json

API Permissions

When generating an API key the token is scoped to specific permissions that control what data can be accessed. Current available permissions are:

  • app-intake-read — Allows reading of intake records and submission data for your deployed applications

Available API Endpoints

Records by Application ID

Retrieve all submission records for a specific deployed application.

  • Method: GET
  • URL: https://seygov.com/api/records-by-app-id/{application}

Record by Intake ID

Retrieve a single submission record by its unique intake ID.

  • Method: GET
  • URL: https://seygov.com/api/record-by-intake-id/{application}/{intake}

For full API documentation including return values and field descriptions refer to the API Documentation section.

Notes

  • Generating a new API key will invalidate any previously generated keys — update all integrations with the new token immediately after generating
  • Store your API key securely and never share it publicly or commit it to source control
  • If your API key is compromised generate a new one immediately from this page to revoke access for the old token
  • API access is tied to your organization's membership plan — contact support if you require additional API permissions or higher request limits
Back to top