canonical: https://jentic.com/apis/peerdom.app/peerdom # Peerdom App Peerdom API Jentic publishes the only available OpenAPI specification for Peerdom API, keeping it validated and agent-ready. Peerdom API provides programmatic access to organizational structure management, including peers (people), roles, groups, projects, and org chart maps. It supports full CRUD operations on all organizational entities and enables role assignment workflows, making it suitable for building dynamic org charts, automating onboarding role assignments, and synchronizing organizational data across HR systems. ## For AI agents Manage organizational structures by creating and updating peers, roles, groups, and projects. Assign roles to people and retrieve org chart maps for a tenant. ## Scope Does not handle payroll, time tracking, or performance reviews - use for organizational structure and role management only. ## Capabilities - Assign and revoke roles for team members within organizational hierarchies - Construct and retrieve visual org chart maps reflecting current team structure - Synchronize peer records with external HR systems through bulk read operations - Create project entities and link them to relevant groups and roles - Model organizational groups with nested role and peer relationships ## Use cases ### Dynamic Org Chart Synchronization Keep organizational charts up to date by syncing peer and role data from Peerdom into internal tools or dashboards. The API exposes 24 endpoints for managing peers, roles, groups, projects, and maps. Agents can poll for changes and propagate updates to Slack channels, wiki pages, or HR platforms in near real-time. Example prompt: Retrieve all roles via GET /roles, then for each role fetch assigned peers via GET `/roles/{roleId}/peers` to build a complete org chart data structure ### Automated Role Assignment During Onboarding Automate the process of assigning roles to new hires during onboarding. When a new peer record is created, the agent can assign appropriate roles based on department and seniority. Peerdom handles role-to-peer mappings with dedicated endpoints for assignment and unassignment, reducing manual HR overhead. Example prompt: Create a new peer with POST /peers using name and department data, then assign the appropriate role via POST `/roles/{roleId}/peers` with the new peer ID ### Cross-System Organizational Data Export Export organizational structures from Peerdom to feed into BI tools, compliance reports, or workforce planning systems. The API provides read access to all entity types including groups, projects, and tenant-level details, enabling periodic bulk exports for analytics or auditing purposes. Example prompt: Retrieve all groups via GET /groups, all peers via GET /peers, and tenant details via GET /tenant, then compile into a structured workforce report ### AI Agent Org Structure Management via Jentic AI agents discover and call Peerdom API operations through Jentic to manage organizational structures without manual integration work. Agents search for org management capabilities by intent, receive typed schemas for each operation, and execute role assignments or peer lookups through a unified interface. Integration takes under an hour compared to days of direct API work. Example prompt: Search Jentic for 'assign a role to a team member', load the POST `/roles/{roleId}/peers` operation schema, and execute with roleId and peerId parameters ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/peers` | List all peers in the organization | | POST | `/peers` | Create a new peer | | GET | `/roles` | List all defined roles | | POST | `/roles/{roleId}/peers` | Assign a role to a peer | | DELETE | `/roles/{roleId}/peers/{peerId}` | Unassign a role from a peer | | GET | `/maps` | Retrieve org chart maps | | GET | `/tenant` | Get tenant details | ## Key resources - **Peers** — Create, read, update, and delete people in the organization - **Roles** — Define organizational roles and manage role-to-peer assignments - **Groups** — Organize roles and peers into logical groups - **Projects** — Track organizational projects - **Maps** — Retrieve and create visual org chart maps - **Tenant** — Access tenant-level organizational details ## Why Jentic - **Setup:** Wiring Peerdom by hand means setting the API-key request header on every request and threading role and peer ids through the assignment endpoints yourself. Through Jentic you install once, import the Peerdom API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Peerdom puts the role and peer id in the URL path (`/roles/{roleId}/peers`, `/roles/{roleId}/peers/{peerId}`), so a rule can pin your agent to managing assignments for a specific role. You choose the operations it may call, so destructive ones like removing a peer from a role are not included unless you add them. - **Credential handling:** Your Peerdom 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. - **Discovery method:** Agents search Jentic by intent such as 'assign a role to a team member', and Jentic returns the matching Peerdom operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **ChartHop API** — ChartHop offers broader org planning with compensation and headcount analytics alongside structure management. - **BambooHR API** — BambooHR handles employee records, time-off, and payroll data that feed into Peerdom's org structure. - **HiBob API** — HiBob provides full HRIS capabilities including payroll, onboarding, and performance that complement Peerdom's org chart focus. ## FAQ ### Why is there no official OpenAPI spec for Peerdom API? Peerdom does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Peerdom API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Peerdom API use? The Peerdom API uses an API key passed in the X-Api-Key request header. Through Jentic, your API key is stored encrypted in the credential vault and agents receive scoped access without the raw key entering their context. ### Can I assign roles to multiple peers in bulk with the Peerdom API? The API handles role assignments one at a time via POST `/roles/{roleId}/peers` with a specific peer ID. For bulk assignments, agents iterate over a list of peer IDs and call the assignment endpoint for each. There is no single bulk-assign endpoint. ### How do I retrieve the full org chart through the Peerdom API via Jentic? Search Jentic for 'get org chart map' to discover the GET /maps endpoint. Load the operation schema, execute the call, and receive the current org chart structure. You can also combine GET /roles with GET `/roles/{roleId}/peers` to construct a role-based hierarchy programmatically. ### What are the rate limits for the Peerdom API? The OpenAPI spec does not document specific rate limits. In practice, standard API key-authenticated services typically enforce per-minute request caps. Monitor HTTP 429 responses and implement exponential backoff in your agent logic. ### Can I create and manage org chart maps programmatically? Yes. POST /maps creates a new draft map, and GET /maps returns all existing maps for the tenant. Maps represent visual org chart layouts. Combine map retrieval with peer and role data to render complete organizational visualizations. ### Can I limit what my agent is allowed to do with the Peerdom API? Yes. Because you run Jentic One yourself, your own rules decide which Peerdom operations and which API key the agent may use. Peerdom puts the role and peer IDs directly in the URL path, such as POST `/roles/{roleId}/peers`, so you can pin the agent to assigning peers within a specific role rather than the whole organization. Destructive calls like DELETE `/roles/{roleId}/peers/{peerId}` stay out of reach unless you explicitly add them to the operations the agent is allowed to call.