Know of an official OpenAPI document? Contribute it →
For Agents
Push a batch of employee person profiles, with company, contact, address, and emergency contact details, into one Restrata tenant and get per-profile validation errors back.
Use for: I need to sync new starters from our HR system into Restrata, Push updated job titles and departments for employees into Restrata, Add emergency contacts to traveller profiles in Restrata, Find out which person profiles failed validation in the last sync
Not supported: Does not handle static site locations, payroll, travel bookings, or reading profiles back out of Restrata. Use for bulk loading person profiles into a Restrata tenant only.
The Restrata People Connector API loads person profiles into a Restrata tenant in bulk, so the platform knows who your people are. One synchronous call takes an array of profiles carrying names, company details such as employeeId and jobTitle, contact details, addresses, emergency contacts, and optional medical details, validates each profile, and publishes the batch to NATS JetStream for asynchronous processing. It returns 200 OK, or a 422 that maps each failing profile id to its validation errors.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Restrata People Connector - Person Profile Ingestion 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.
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%2Frestrata.net%2Frestrata-people-ingestion" | shStep 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%2Frestrata.net%2Frestrata-people-ingestion" | 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.
What an agent can do with Restrata People Connector - Person Profile Ingestion API.
Load a batch of person profiles into one Restrata tenant with POST /{tenantId}/sync-people-data
Carry HR fields in companyDetails, such as employeeId, jobTitle, department, and lineManager, for each person
Attach contactDetails typed as EMAIL, MOBILE, or PHONE, with one flagged primary
Include Work or Home addresses and emergencyContacts with relationship and phoneList for each profile
Read the 422 response's map of profile id to validation errors and resubmit only the profiles that failed
Patterns agents use Restrata People Connector - Person Profile Ingestion API for, with concrete tasks.
★ Agent-run HR to Restrata sync through Jentic
An HR operations agent connected through Jentic searches by intent for syncing people into Restrata, gets the sync-people-data operation with its input schema, and posts new and changed employees for one tenant. Each profile carries id, firstName, and lastName, plus companyDetails and contactDetails, and the agent reports any per-profile 422 errors back to you.
POST /{tenantId}/sync-people-data for tenant 'acme' with personProfiles [{id: 'E1042', firstName: 'Aoife', lastName: 'Byrne', active: true, companyDetails: {employeeId: 'E1042', jobTitle: 'Engineer'}, contactDetails: [{contactDetailType: 'EMAIL', contactType: 'Work', value: 'aoife@acme.com', primary: true}]}]
Leaver and status updates
When someone leaves, an agent resends their profile with active set to false so Restrata stops treating them as a current employee. The same call shape updates a changed department, lineManager, or jobTitle, so one operation keeps the people record current.
POST /{tenantId}/sync-people-data with personProfiles [{id: 'E0877', firstName: 'Liam', lastName: 'Walsh', active: false}] for the leaver
Emergency contact completeness
Duty-of-care teams need emergency contacts on file for travelling staff. An agent can collect each person's emergencyContacts, with emergencyContactType, relationship, name, and phoneList, and send them inside the profile so the Restrata record carries who to call.
POST /{tenantId}/sync-people-data with a profile for id 'E1042' that includes emergencyContacts [{emergencyContactType: 'Primary', relationship: 'Spouse', firstName: 'Sean', lastName: 'Byrne', phoneList: ['+353871234567']}]
1 endpoints — the restrata people connector api loads person profiles into a restrata tenant in bulk, so the platform knows who your people are.
METHOD
PATH
DESCRIPTION
/{tenantId}/sync-people-data
Sync a batch of person profiles
/{tenantId}/sync-people-data
Sync a batch of person profiles
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.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Restrata people connector by hand means holding a per-tenant X-API-Key, choosing the right regional host, and mapping HR records to its nested profile schema. Through Jentic you install once, import the API from the API Directory, store the key once, and your agent calls it.
Permission scoping
Restrata puts the tenant id in the URL path (/{tenantId}/sync-people-data), so a rule can pin your agent to one tenant: it can update people for that tenant and nothing else.
Credential isolation
Your Restrata 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.
Intent-based discovery
Agents search Jentic by intent such as 'sync employee profiles into Restrata', and Jentic returns the matching Restrata operation with its input schema so the agent sends the right fields without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using Restrata People Connector - Person Profile Ingestion API through Jentic.
What authentication does the Restrata People Ingestion API use?
Per its OpenAPI spec, the API takes an API key in the X-API-Key header, and Restrata generates a random key per tenant and endpoint. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time.
Which fields does a Restrata person profile require?
Each entry in personProfiles requires id, firstName, and lastName. Everything else is optional, including companyDetails, contactDetails, addresses, emergencyContacts, and medicalDetails. A contactDetails entry needs contactDetailType (EMAIL, MOBILE, or PHONE), contactType, and value, and dateOfBirth must be an ISO date that is not in the future.
What are the rate limits for the Restrata People Ingestion API?
The OpenAPI spec does not specify rate limits or a maximum batch size. Ask Restrata Platform Engineering, the contact listed in the spec at platform@restrata.com, for current limits before syncing a full workforce in one batch.
Is there a Restrata People Connector MCP server?
You don't need an MCP server to give your agent the Restrata People Ingestion API. Jentic connects it directly from the API Directory: import it, store your API key once, and your agent calls it. Operations are found by intent when needed, so no extra tool definitions sit in your agent's context.
How do I sync employee profiles into Restrata through Jentic?
Install Jentic One, add the Restrata People Ingestion API from the directory, and store the X-API-Key Restrata issued for your tenant. Your agent searches for 'sync person profiles into Restrata', gets POST /{tenantId}/sync-people-data with its schema, and posts the personProfiles array. To run it on your own infrastructure, install Jentic One from its GitHub repo.
Can I limit what my agent is allowed to do with the Restrata People Ingestion API?
Yes. Write a rule that allows POST /acme/sync-people-data only, so the agent can update people in the acme tenant but cannot write profiles into any other tenant id, and every call it makes is logged.
GET STARTED