Public documentation

PurpleSuite API contracts

Stable, directly reachable references for every published native and vendor-painted profile. Machine-readable contracts live beside these human pages.

These are emulated integration contracts for PurpleSuite. Vendor names describe compatibility targets; PurpleSuite is not affiliated with those vendors.

ats

Purple Suite ATS API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/ats
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

bank-ops

Purple Bank Ops API

purplesuite

BFSI bank operations source system: branch control tower (opening checklists, pending approvals, escalations, operational-risk register) and trade finance (letters of credit with milestones/bottlenecks, bank guarantees). Records carry a `c…

Runtime
/api/purple-suite/bank-ops
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

calendar

Microsoft Graph-compatible Calendar API for Purple Suite. When a request carries a caller identity (X-PS-Impersonate-User header, or the instance's default MCP user), Outlook-style permissions apply: `private` events are masked on reads un…

Runtime
/api/purple-suite/calendar
Primary
native-openapi

chat

Purple Suite Chat API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/chat
Primary
native-openapi

cloud-logs

Read-only synthetic cloud inventory and application observations. Correlate project, stable resource identity, FQDN and observation time with your inventory source. Does not modify cloud infrastructure or CMDB relationships. --- **Acting a…

Runtime
/api/purple-suite/cloud-logs
Primary
native-openapi

community

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/community
Primary
native-openapi

crm

Purple Suite CRM API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/crm
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

dex

Purple Suite DEX API

purplesuite

Digital Employee Experience (DEX) API — monitor device health, software inventory, experience scores, alerts, remediations, and IT campaigns. Resembles tools like Nexthink, Lakeside, and ServiceNow DEX. --- **Acting as a user (`X-PS-Impers…

Runtime
/api/purple-suite/dex
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

erp

Purple Suite ERP API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/erp
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

expense

SAP Concur

concur

concur contract for expense

Runtime
/api/purple-suite/{instanceId}/contracts/expense/concur
Primary
concur-expense-reports-v3
v3.0; SAP-docs/preview.developer.concur.com @ main, src/api-explorer/v3-0 Swagger 2.0 setrestopenapi
OpenAPI JSON
v3.0; SAP-docs/preview.developer.concur.com @ main, src/api-explorer/v3-0 Swagger 2.0 setrestopenapi
OpenAPI JSON
v3.0; SAP-docs/preview.developer.concur.com @ main, src/api-explorer/v3-0 Swagger 2.0 setrestopenapi
OpenAPI JSON

Purple Expense API

purplesuite

Purple Expense — travel & expense management. Search bookable flight and hotel inventory, book trips, capture receipts, submit expense reports, and run approvals. Resembles tools like SAP Concur, Navan, and Expensify. --- **Acting as a use…

Runtime
/api/purple-suite/expense
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

grid

Purple Suite Grid API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/grid
Primary
native-openapi

hrbp

Purple Suite HRBP API

purplesuite

HR Business Partner (HRBP) source system — Talent Insights & Talent Review, and Employee Relations case management. Data layer for talent reviews, 9-box employee assessments, performance reviews, succession planning, metric snapshots, and …

Runtime
/api/purple-suite/hrbp
Primary
native-openapi

hris

Purple Suite HRIS API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/hris
Primary
native-openapi

Workday

workday

workday contract for hris

Runtime
/api/purple-suite/{instanceId}/contracts/hris/workday
Primary
staffing-v7

identity

Purple Identity API

purplesuite

Purple Identity — the canonical people directory for a Purple Suite instance. Every other app (HRIS, Calendar, Expense, ITSM, …) draws its internal people from this same roster, so an email means the same person everywhere. Exposes an ODat…

Runtime
/api/purple-suite/identity
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

instances

itsm

Purple Suite ITSM API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/itsm
Primary
native-openapi

lms

Purple Suite LMS API

purplesuite

Learning Management System (LMS) API — manage a course catalog and learner enrollments. Resembles tools like Cornerstone, Docebo, and SAP SuccessFactors Learning. Pairs with Purple HRS skills/goals for skill-gap-driven learning. --- **Acti…

Runtime
/api/purple-suite/lms
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

manager-experience

pages

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/pages
Primary
native-openapi

pm

Purple Suite PM API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/pm
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

purple-talent

Mock of external talent-intelligence MCP tools. Tool surface includes original 6 confirmed tools plus 15 extended Studio tools. All data is deterministic per instance — see ./evalFixture.ts. See docs/superpowers/specs/2026-07-13-purple-tal…

Runtime
/api/purple-suite/purple-talent
Primary
native-openapi

retail-banking

Core retail banking source system: customers, accounts, transactions, cards, products, loans & applications, plus the relationship/servicing layer (interactions, opportunities, complaints). Every record carries a `country` (IN | AU | US) a…

Runtime
/api/purple-suite/retail-banking
Primary
native-openapi

risk-compliance

BFSI risk & compliance source system: KYC/CDD profiles & remediation, fraud alerts & investigation cases, AML watchlist, and policy/SOP knowledge. Customer-linked records share the retail-banking `customer_id` (CUST-####). Records carry a …

Runtime
/api/purple-suite/risk-compliance
Primary
native-openapi

scm

Purple Suite SCM API

purplesuite

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if…

Runtime
/api/purple-suite/scm
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

tasks-approvals

time

Purple Time API

purplesuite

Workforce time & attendance — clock in/out, meal and rest breaks, schedules, timecards, and meal-break compliance exceptions. Resembles tools like ADP Time and Ceridian Dayforce. The signature flow is meal-break compliance: `POST /meal-com…

Runtime
/api/purple-suite/time
Primary
native-openapi
1.0.0restopenapi
OpenAPI JSON

workiq

Conversational workplace-assistant API. Resembles Microsoft 365 Copilot / WorkIQ-style chat: start a session, then submit natural-language queries and receive synthesized answers with citations over the tenant's mail, calendar and collabor…

Runtime
/api/purple-suite/workiq
Primary
native-openapi