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

# Planday.Platform.Api

Planday.Platform.Api - OpenAPI Specification. The API exposes 46 endpoints.

## For AI agents

Programmatically creates new booking for shift, returns a booking for a given bookingid. Covers 46 operations.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Creates new booking for shift
- Returns a Booking for a given bookingId
- Departments_CreateDepartmentBydepartment
- Departments_GetDepartmentsByquery.filter.search_queryquery.filter.include_delete
- Departments_GetByid
- Departments_UpdateDepartmentByiddepartment
- Departments_DeleteByidremoveEmployees

## Use cases

### Developer Tools Operations

Use the Planday.Platform.Api to perform developer tools operations programmatically. The API provides 46 endpoints covering core functionality including creates new booking for shift, returns a booking for a given bookingid, departments_createdepartmentbydepartment.

Example prompt: Call POST `/Schedule/{departmentId}/shifts/{shiftId}/bookings` to creates new booking for shift

### Automated Booking Management

Automate booking operations by combining multiple Planday.Platform.Api endpoints. Agents can returns a booking for a given bookingid and then departments_createdepartmentbydepartment in a single workflow.

Example prompt: Call GET `/Schedule/{departmentId}/bookings/{bookingInterestDescriptionId}` to returns a booking for a given bookingid, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Planday.Platform.Api endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'creates new booking for shift', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/Schedule/{departmentId}/shifts/{shiftId}/bookings` | Creates new booking for shift |
| GET | `/Schedule/{departmentId}/bookings/{bookingInterestDescriptionId}` | Returns a Booking for a given bookingId |
| POST | `/departments` | Departments_CreateDepartmentBydepartment |
| GET | `/departments` | Departments_GetDepartmentsByquery.filter.search_queryquery.filter.include_delete |
| GET | `/departments/{id}` | Departments_GetByid |
| PUT | `/departments/{id}` | Departments_UpdateDepartmentByiddepartment |
| DELETE | `/departments/{id}` | Departments_DeleteByidremoveEmployees |
| GET | `/departments/employees/{id}/departments` | Departments_GetDepartmentsForEmployeeByid |

## Key resources

- **Booking** — Operations related to Booking
- **Departments** — Operations related to Departments
- **Employees** — Operations related to Employees
- **HourlyPayRate** — Operations related to HourlyPayRate
- **Invites** — Operations related to Invites

## AI readiness

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.

- **Score:** 37 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 64 / 100
  - Developer Experience & Jentic Compatibility: 56 / 100
  - AI-Readiness & Agent Experience: 14 / 100
  - Agent Usability: 94 / 100
  - Security: 100 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/plandayplatformapi/plandayplatformapi/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Planday Platform API by hand means hand-building requests across its schedule, booking and department endpoints and threading whatever access header each call needs yourself. Through Jentic you install once, import the Planday Platform API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** The Planday Platform API puts the resource id in the URL path (`/departments/{id}`, `/Schedule/{departmentId}/shifts/{shiftId}/bookings`), so a rule can pin your agent to one department: it reads and books shifts for that department and nothing else. You choose the operations it may call, so destructive ones like deleting a department are not included unless you add them.
- **Credential handling:** Your Planday Platform credential 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 'create a booking for a shift' or 'list departments', and Jentic returns the matching Planday Platform operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Planday.Platform.Api use?

The Planday.Platform.Api uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I creates new booking for shift with the Planday.Platform.Api?

Yes. Use the POST `/Schedule/{departmentId}/shifts/{shiftId}/bookings` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Planday.Platform.Api?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I creates new booking for shift through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'creates new booking for shift'. Jentic returns the matching Planday.Platform.Api operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Planday.Platform.Api have?

The Planday.Platform.Api exposes 46 endpoints covering booking, departments, employees operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Planday Platform operations and credentials the agent may use. Since Planday puts the resource id in the URL path, such as `/departments/{id}` and `/Schedule/{departmentId}/shifts/{shiftId}/bookings`, you can pin the agent to a single department so it only reads and books shifts there. You also choose the exact operations it may call, so destructive ones like deleting a department stay out of reach unless you explicitly grant them.