What is a Connector?
Connectors are the secure data bridges that link Evo to your Access Policies & Procedures system. They expose specific operations — called endpoints — that Navigators, Researcher, Agents, and Workflows use behind the scenes. Understanding connectors helps you know what data is available and who can access it.
The Access Policies & Procedures Connector
18 Available Endpoints
2 Functional Areas
4 Role Levels
The connector provides read-only access to your organisation's policy and policy compliance data. All calls are authenticated via bearer token — your identity and organisation are resolved automatically. No data is written or modified through this connector.
Policies Area
Endpoints for retrieving, reading, and managing policy content.
Endpoint | What it does | Who can use it |
getMyPolicies | Returns all published policies the authenticated user is allowed to see. The primary entry point for frontline care staff. | All Users |
viewPolicy | Returns a single published policy including a secure, short-lived link to read its document content. | All Users |
getPolicyContent | Returns the readable section text of a policy directly — no secure link needed. Supports Draft, Published, and ToReview states. | All Users (Published) Editor / Admin (Draft, ToReview) |
getPolicyByStatus | Retrieves a policy at a specific status (Draft, Published, or ToReview) with a secure document link. Use when a particular status is required. Editors only get policy types they are assigned to. | All Users (Published) Editor / Admin (Draft, ToReview) |
getPolicyVersions | Returns the previous versions of a policy (optionally including the current published version), each version with its own secure document link. Use for audits and version comparisons. | All Users |
checkPolicyHasDraft | Checks whether an active (non-archived) draft already exists for a policy. Prevents duplicate review work. | Editor / Admin |
getPoliciesApproachingReview | Returns published policies whose next review date is overdue or falls within a configurable window (default: 30 days). | Editor / Admin |
getPolicyReviewCheckPages | Returns the page numbers to iterate over when running a review check — calls this first to know how many pages to fetch. | Editor / Admin |
runPolicyReviewCheck | Returns one page of policies approaching or overdue for review, excluding those already in draft, with their assigned editors resolved. | Editor / Admin |
getOnboardingPolicies | Returns the policies linked to a specific onboarding step number, including Draft and ToReview versions (Editors only see the policy types they are assigned to). Used to build structured new-starter reading plans — use only the Published items for staff. | Editor / Admin |
searchAllPolicies | Keyword search on policy names across all policies in the organisation (Editors only see the policy types they are assigned to), optionally filtered by policy type and status. Requires Editor or Administrator role. | Editor / Admin |
getPolicyTypes | Returns the policy types configured for your organisation (e.g. Health & Safety). Used to filter other endpoints. | All Users |
getEditorsForPolicyType | Returns the editors assigned to a policy type, always including Administrators. Falls back to all Editors/Admins in the organisation if none are explicitly assigned. | Editor / Admin |
Compliance Area
Endpoints for monitoring staff reading compliance. All require Manager, Editor or Administrator role.
Endpoint | What it does | Who can use it |
getComplianceSummary | Returns read, to-read, and overdue counts per policy for the manager's team. The fastest way to get a compliance health check. | Manager / Editor / Admin |
getUnreadCompliance | Paginated list of policies still to be read before their due date. Filter by policy name, staff name, or policy type. | Manager / Editor / Admin |
getReadCompliance | Paginated list of policies that have already been read by team members. Useful for positive compliance reporting. | Manager / Editor / Admin |
getOverdueCompliance | Paginated list of policies whose due date has passed without being read. One row per policy version with overdue user count. | Manager / Editor / Admin |
getPolicyVersionUsers | Returns the named staff members in a specific compliance state (assigned — still to read, completed, or overdue) for one version of a policy. | Manager / Editor / Admin |
Security & Access Model
Authentication
Every request is authenticated via a bearer token. Your user identity, organisation, and role are resolved automatically — you never need to enter them manually.
Authorisation
Access is enforced at the endpoint level. Compliance endpoints are scoped to the users your compliance permissions cover (hierarchy, location or groups) — you can never see data outside your remit.
Data Privacy
Compliance endpoints return names and job titles only — email addresses are never returned by compliance endpoints. Editor lookups (getEditorsForPolicyType and runPolicyReviewCheck) include editor email addresses. Policy documents are served via short-lived secure links that expire automatically after 30 seconds.
Read-Only
The connector is entirely read-only. No policy content, compliance records, or user data can be created, modified, or deleted through Evo.
Policy Status Reference
Status Code | Name | Description |
0 | Draft | Policy is being authored or updated. Not visible to staff. |
1 | Published | Policy is live and visible to all assigned users. |
2 | ToReview | Policy has been flagged for review. Editors can access it; staff see the last published version. |
99 | Deleted | Policy has been removed. Never retrievable via the connector. |
Pagination Guide
The compliance list endpoints (getUnreadCompliance, getReadCompliance, getOverdueCompliance) and the Policy Review Check return data in pages to keep responses fast; getComplianceSummary and getPolicyVersionUsers return all results in one response. Here's how to navigate them:
Set pageSize between 1 and 15 (compliance endpoints, required; other values are rejected) or 1 and 200 (review check, default 20; other values are clamped).
For compliance endpoints, start with page=1 and increment until hasMore is false.
For the Policy Review Check, call getPolicyReviewCheckPages first to get the full list of page numbers, using the same pageSize and threshold on both calls.
Pages may contain fewer items than pageSize when policies with existing drafts are filtered out