canonical: https://jentic.com/apis/swaggerhub.alayacare/alayacare-forms-api

# AlayaCare Forms API

**Internal IDs:** The following terms are used to reference IDs that identify resources in AlayaCare: - account_id - client_user_id **External IDs:** External IDs are required to be unique. No other assumptions are made regarding their form; they are treated as strings. The following terms are used to reference IDs that identify resources in systems external to AlayaCare: - external_client_id - ex. The API exposes 5 endpoints secured with basic authentication.

## For AI agents

Programmatically get a list of submissions.
, get form submission details by form submission id.
. Covers 5 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for hr and recruiting only.

## Capabilities

- Get a list of submissions.
- Manage hr recruiting data programmatically
- Integrate AlayaCare Forms API into automated workflows
- Query and filter AlayaCare Forms API records by parameters
- Monitor AlayaCare Forms API operational status and events

## Use cases

### HR and Recruiting Operations

Use the AlayaCare Forms API to perform hr recruiting operations programmatically. The API provides 5 endpoints covering core functionality including get a list of submissions.
, get form submission details by form submission id.
, get the count of approved form submissions and the total count of form submissio.

Example prompt: Call GET /submissions to get a list of submissions.

### Automated Submissions Management

Automate submissions operations by combining multiple AlayaCare Forms API endpoints. Agents can get form submission details by form submission id.
 and then get the count of approved form submissions and the total count of form submissio in a single workflow.

Example prompt: Call GET /submissions/{submission_id} to get form submission details by form submission id.
, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call AlayaCare Forms 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 basic tokens manually.

Example prompt: Search Jentic for 'get a list of submissions.
', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /submissions | Get a list of submissions. |
| GET | /submissions/{submission_id} | Get form submission details by form submission ID. |
| GET | /submissions/count_visit_submissions | Get the count of approved form submissions and the total count of form submissio |
| GET | /submissions/visits | Get a list of visits and submissions given a client id. |
| GET | /submissions/{submission_id}/submission_revision | Get form submission change logs. |

## Key resources

- **Submissions** — Operations for submissions

## Why Jentic

- **Setup:** Wiring the AlayaCare Forms API by hand means setting up its HTTP basic auth over https and calling submission list, count, and revision operations yourself against the AlayaCare Canada host. Through Jentic you install once, import the AlayaCare Forms API from the API Directory, store the basic credential once, and your agent calls it.
- **Permission scoping:** The AlayaCare Forms API puts the submission id in the URL path (/submissions/{submission_id}), so a rule can pin your agent to one submission: it can read that submission and its revision and nothing else. This API exposes read operations only, so the agent reads submissions without any write access.
- **Credential handling:** Your AlayaCare Forms API basic credential 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 a list of submissions' or 'count visit submissions', and Jentic returns the matching AlayaCare Forms API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Greenhouse** — Alternative hr recruiting API
- **Lever** — Alternative hr recruiting API
- **Workday** — Complementary hr recruiting API

## FAQ

### What authentication does the AlayaCare Forms API use?

The AlayaCare Forms API uses HTTP Basic authentication with username and password. 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 a list of submissions.
 with the AlayaCare Forms API?

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

### What are the rate limits for the AlayaCare Forms 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 a list of submissions.
 through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get a list of submissions.
'. Jentic returns the matching AlayaCare Forms API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the AlayaCare Forms API have?

The AlayaCare Forms API exposes 5 endpoints covering submissions operations.

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

Yes. Jentic One is self-hosted, so you set the rules that decide which AlayaCare Forms operations and credentials your agent may use. Because the API exposes only read calls (listing submissions, fetching a submission by ID, counting visit submissions, and reading submission change logs), a rule can hold your agent to reading without any write access. Since the submission ID sits in the URL path at /submissions/{submission_id}, you can also pin the agent to a single submission so it reads only that submission and its revision.