AlayaCare Forms API
Browse all Swaggerhub Alayacare APIs★ Only Publicly Available OpenAPI DocumentHR recruitingEmployee Managementbasic5 EndpointsREST
For Agents
Programmatically get a list of submissions. , get form submission details by form submission id. . Covers 5 operations with basic authentication.
Use for: I need to a list of submissions. , I want to form submission details by form submission id. , Search for the count of approved form submissions and the total count of form submissio, Find all a list of visits and submissions given a client id.
Not supported: Does not handle payments, communications, or crm - use for hr and recruiting only.
**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.
Install Jentic One Beta
Connect the AlayaCare Forms API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the AlayaCare Forms API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fswaggerhub.alayacare%2Falayacare-forms-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fswaggerhub.alayacare%2Falayacare-forms-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with AlayaCare Forms API.
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
Patterns agents use AlayaCare Forms API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'get a list of submissions. ', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
5 endpoints — **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.
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.
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.
Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using AlayaCare Forms API through Jentic.
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.
GET STARTED