canonical: https://jentic.com/apis/organimi.com/organimi

# Organimi API

Jentic publishes the only available OpenAPI specification for Organimi API, keeping it validated and agent-ready. Organimi is a cloud org-chart platform used by HR and people-ops teams to maintain visual organization charts, talent pools, and reporting hierarchies. The API spans 23 endpoints across organizations, people, custom fields, charts, roles, and exports, letting integrations sync HRIS data into a live chart and pull rendered charts in PDF, PNG, or CSV. It supports OAuth login plus bearer-token API access, and it is suitable for keeping org charts in lock-step with payroll or directory sources.

## For AI agents

Manage organizations, people, charts, and roles in Organimi, and export rendered org charts in multiple formats.

## Scope

Does not handle payroll, time tracking, or performance reviews - use for org chart structure, people records, and role exports only.

## Capabilities

- List the organizations the authenticated user belongs to via GET `/api/v7/me/organizations`
- Add a new person to the talent pool of an organization with POST `/api/v7/organizations/{orgId}/people`
- Update or remove an employee record using PATCH or DELETE on `/api/v7/organizations/{orgId}/people/{personId}`
- Define custom fields on people records through POST `/api/v7/organizations/{orgId}/fields`
- Create a new org chart and populate roles via POST `/api/v7/organizations/{orgId}/charts` and `/charts/{chartId}/roles`
- Export a chart to PDF, PNG, or CSV through GET `/api/v7/organizations/{orgId}/charts/{chartId}/exports/{format}`
- Search across roles in the connected organizations using GET `/api/v7/search/roles`

## Use cases

### HRIS to Org Chart Sync

People-ops teams often hold the source of truth in BambooHR, Workday, or a directory service while leaders prefer a visual chart. The Organimi API lets a sync job push people, titles, and reporting lines into Organimi after each HRIS change so the chart never drifts. The 23 endpoints cover the full CRUD surface needed for daily reconciliation.

Example prompt: On each HRIS webhook, POST or PATCH `/api/v7/organizations/{orgId}/people` to mirror the change, then PATCH the matching role on the relevant chart.

### Automated Org Chart Exports

Boards and leadership often request a current PDF org chart for monthly reviews. Instead of manually exporting, a scheduled job can call GET `/api/v7/organizations/{orgId}/charts/{chartId}/exports/{format}` to pull the latest chart as PDF, PNG, or CSV and attach it to the report pipeline.

Example prompt: Call GET `/api/v7/organizations/{orgId}/charts/{chartId}/exports/pdf` and upload the binary response to the shared drive used for the board pack.

### Custom Field Driven Reporting

Finance often wants to slice headcount by cost center or location. Defining custom fields via POST `/api/v7/organizations/{orgId}/fields` lets people-ops add structured attributes that flow into chart filters and exports without modifying core people records.

Example prompt: POST a custom field cost_center to `/api/v7/organizations/{orgId}/fields`, then PATCH each person record to populate it.

### Agent-Driven People Operations via Jentic

Agents that handle onboarding and directory updates can keep Organimi in sync without learning the API surface. Jentic exposes operations by intent and isolates the bearer token in the vault, letting an agent add a hire, assign a role, and export the updated chart in one workflow.

Example prompt: Use Jentic to search 'add a person to the org chart', load the schema for POST `/api/v7/organizations/{orgId}/people`, and execute with the new hire details.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v7/me/organizations` | List organizations the user belongs to |
| POST | `/api/v7/organizations/{orgId}/people` | Add a person to the talent pool |
| PATCH | `/api/v7/organizations/{orgId}/people/{personId}` | Update a person record |
| POST | `/api/v7/organizations/{orgId}/charts` | Create a new org chart |
| POST | `/api/v7/organizations/{orgId}/charts/{chartId}/roles` | Add a role to a chart |
| GET | `/api/v7/organizations/{orgId}/charts/{chartId}/exports/{format}` | Export a chart as PDF, PNG, or CSV |
| GET | `/api/v7/search/roles` | Search across roles |

## Key resources

- **Organizations** — Read, update, and delete organizations the user has access to
- **People** — CRUD operations on members of the talent pool
- **Charts** — Create, update, and delete org charts
- **Roles** — Create and list roles within a chart
- **Custom Fields** — Define structured attributes on people records
- **Exports** — Export charts as PDF, PNG, or CSV
- **Auth** — OAuth login and logout flows

## Why Jentic

- **Setup:** Wiring the Organimi API by hand means setting up its bearer auth and threading the orgId and chartId through the people, chart, and role routes yourself. Through Jentic you install once, import Organimi from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Organimi puts the organization id in the URL path (`/organizations/{orgId}/people`, `/organizations/{orgId}/charts`), so a rule can pin your agent to one organization: it can work with that org's people and charts and nothing else. You choose the operations it may call, so editing a person or creating a chart is not included unless you add it.
- **Credential handling:** Your Organimi bearer token 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 'add a person to the org chart' or 'export a chart', and Jentic returns the matching Organimi operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **BambooHR API** — BambooHR is a common HRIS source of truth that feeds people, titles, and reporting lines into Organimi.
- **Workday Staffing API** — Workday Staffing provides workforce records that Organimi consumes to build the visual hierarchy.
- **Figma REST API** — Figma is sometimes used to manually maintain org charts as design files instead of a structured org-chart tool.

## FAQ

### Why is there no official OpenAPI spec for Organimi API?

Organimi publishes its API on SwaggerHub but does not host a maintained OpenAPI document on its own domain. Jentic generates and maintains this spec so that AI agents and developers can call Organimi 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 Organimi API use?

Organimi uses bearer-token authentication, with OAuth login and logout endpoints under `/api/v7/auth.` Through Jentic the bearer token is stored encrypted in the vault and injected at execution.

### Can I export an org chart as a PDF through the Organimi API?

Yes. Call GET `/api/v7/organizations/{orgId}/charts/{chartId}/exports/{format}` with format set to pdf. PNG and CSV are also supported on the same endpoint.

### What are the rate limits for the Organimi API?

The OpenAPI spec does not specify numeric rate limits. SwaggerHub publishes Organimi's terms but not throttle thresholds - confirm with Organimi support if you plan to push more than a few hundred people updates per minute.

### How do I add a new hire to an Organimi chart through Jentic?

Search Jentic for 'add a person to an org chart', load the POST `/api/v7/organizations/{orgId}/people` schema, and execute with the new hire's name, title, and reporting manager. Then PATCH the relevant chart role to slot them into the structure.

### Can I define custom fields on Organimi people records?

Yes. POST `/api/v7/organizations/{orgId}/fields` creates a new custom field definition. After creation, PATCH `/api/v7/organizations/{orgId}/people/{personId}` can populate that field for individual people.

### Can I limit what my agent is allowed to do with the Organimi API?

Yes. Jentic One is self-hosted, so you run it and your own rules decide which operations and credentials your agent may use. Because Organimi carries the organization id in the URL path (`/organizations/{orgId}/people`, `/organizations/{orgId}/charts`), you can pin the agent to a single organization and let it touch only that org's people, charts, and role or export routes. You also choose the exact operations it may call, so read-only actions like listing charts or exporting a PDF can be enabled while editing a person or creating a chart stays off unless you add it.