canonical: https://jentic.com/apis/spectrumemp.com/spectrumemp

# Spectrumemp Liaison API

Liaison (Spectrum EMP) API for managing student enrollment forms, field rules, and student sources. Supports form submission, field requirement retrieval, and source management. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get form field requirements, submit a form. Covers 6 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for education only.

## Capabilities

- Get form field requirements
- Submit a form
- List student sources
- Query and filter Liaison API records by parameters
- Monitor Liaison API operational status and events

## Use cases

### Education Operations

Use the Liaison API to perform education operations programmatically. The API provides 6 endpoints covering core functionality including get form field requirements, submit a form, get submittable forms.

Example prompt: Call GET `/forms/requirements` to get form field requirements

### Automated Field Rules Management

Automate field rules operations by combining multiple Liaison API endpoints. Agents can submit a form and then get submittable forms in a single workflow.

Example prompt: Call POST `/forms/submit` to submit a form, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Liaison API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get form field requirements', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/forms/requirements` | Get form field requirements |
| POST | `/forms/submit` | Submit a form |
| GET | `/forms/submittable` | Get submittable forms |
| GET | `/field_rules/all_client_rules` | Get all field rule dependencies |
| POST | `/field_rules/field_options` | Get dependent field options (deprecated) |
| GET | `/sources/list` | List student sources |

## Key resources

- **Field Rules** — Operations related to Field Rules
- **Forms** — Operations related to Forms
- **Sources** — Operations related to Sources

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 48 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 87 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 15 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/spectrumemp.com/spectrumemp/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Liaison API by hand means passing your key as the IQS-API-KEY query parameter on every request and wiring the form, field-rule, and source operations yourself. Through Jentic you install once, import the Liaison API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Liaison API targets travel in the request body and query, not a resource path, so limit the agent to the operations it needs, such as reading form requirements or submitting a form. You choose the operations it may call, so it only does what you allow and nothing more.
- **Credential handling:** Your Liaison API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get form field requirements' or 'submit a form', and Jentic returns the matching Liaison operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Schoology** — Alternative education API
- **Stripe** — Complementary API for broader integration workflows
- **Twilio** — Complementary API for broader integration workflows

## FAQ

### What authentication does the Liaison API use?

The Liaison API uses an API key passed in the `IQS-API-KEY` query. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get form field requirements with the Liaison API?

Yes. Use the GET `/forms/requirements` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Liaison API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get form field requirements through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get form field requirements'. Jentic returns the matching Liaison API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Liaison API have?

The Liaison API exposes 6 endpoints covering field rules, forms, sources operations.

### Can I limit what my agent is allowed to do with the Liaison API?

Yes. Because you run Jentic One yourself, your own rules decide which Liaison API operations and credentials the agent may use. Since the Liaison API selects targets through the request body and query rather than a resource path, you scope the agent by choosing the exact operations it can call, such as reading form requirements with GET `/forms/requirements` or submitting a form with POST `/forms/submit`, while withholding others like listing student sources. The agent does only what you allow and nothing more.