# Schedules
{% hint style="warning" %}
**Navixy Repository API is a work in progress.** This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.
{% endhint %}
Schedules define time-based rules using iCalendar ([RFC 5545](https://www.rfc-editor.org/rfc/rfc5545.html)) format for recurring events, working hours, and time-triggered automation.
## Queries
### schedule
Retrieves a schedule by its ID.
```graphql
schedule(id: ID!): Schedule
```
**Arguments**
| Name | Type | Description |
| ---- | ----- | ----------------------------------- |
| `id` | `ID!` | The ID of the schedule to retrieve. |
**Output types:**
Schedule
A schedule definition for work hours, maintenance windows, or other time-based rules.
**Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#type-titled), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned)
| Field | Type | Description |
| -------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The human-readable display name. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization that owns this schedule. |
| `scheduleData` | `ScheduleData!` | The calendar and time interval definitions for this schedule. |
Organization (entity)
An organization in the hierarchy that owns entities and users.
**Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#type-titled)
| Field | Type | Description |
| ------------ | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The human-readable display name. |
| `externalId` | `String` | An external system identifier for integration purposes. |
| `isActive` | `Boolean!` | Whether this organization is active. |
| `features` | \[[OrganizationFeature](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organizationfeature)!]! | The feature flags enabled for this organization. |
| `parent` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization) | The parent organization in the hierarchy. Null for root organizations. |
| `children` | [OrganizationConnection](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organizationconnection)! | The child organizations. |
| `members` | [MemberConnection](/docs/navixy-repository-api/core-api-reference/organizations/members.md#type-memberconnection)! | The members of this organization. |
| `devices` | [DeviceConnection](/docs/navixy-repository-api/core-api-reference/devices/types.md#type-deviceconnection)! | The devices owned by this organization. |
| `assets` | [AssetConnection](/docs/navixy-repository-api/core-api-reference/assets/types.md#type-assetconnection)! | The assets owned by this organization. |
| `geoObjects` | [GeoObjectConnection](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-geoobjectconnection)! | The geographic objects owned by this organization. |
| `schedules` | [ScheduleConnection](#type-scheduleconnection)! | The schedules owned by this organization. |
***
### schedules
Lists schedules for an organization.
```graphql
schedules(
organizationId: ID!
filter: ScheduleFilter
first: Int
after: String
last: Int
before: String
orderBy: ScheduleOrder = { field: TITLE, direction: ASC }
): ScheduleConnection!
```
**Arguments**
| Name | Type | Description |
| ---------------- | ---------------- | ------------------------------------------------------------------------------------------------ |
| `organizationId` | `ID!` | The organization to retrieve schedules for. |
| `filter` | `ScheduleFilter` | Filtering options for the returned schedules. |
| `first` | `Int` | The first `n` elements from the [paginated list](/docs/navixy-repository-api/pagination.md). |
| `after` | `String` | The elements that come after the specified [cursor](/docs/navixy-repository-api/pagination.md). |
| `last` | `Int` | The last `n` elements from the [paginated list](/docs/navixy-repository-api/pagination.md). |
| `before` | `String` | The elements that come before the specified [cursor](/docs/navixy-repository-api/pagination.md). |
| `orderBy` | `ScheduleOrder` | The ordering options for the returned schedules. |
**Input types:**
ScheduleFilter
Filtering options for schedules.
| Field | Type | Description |
| --------------- | -------- | --------------------------------------------------- |
| `titleContains` | `String` | Partial match on title (case-insensitive contains). |
ScheduleOrder
Ordering options for schedules.
| Field | Type | Description |
| ----------- | ----------------------------------------------------------------------------------------------- | ------------------------------- |
| `field` | [ScheduleOrderField](#type-scheduleorderfield) | The standard field to order by. |
| `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. |
**Output types:**
ScheduleConnection
A paginated list of Schedule items.
**Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection)
| Field | Type | Description |
| ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| `edges` | \[[ScheduleEdge](#type-scheduleedge)!]! | A list of edges. |
| `nodes` | \[[Schedule](#type-schedule)!]! | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-pageinfo)! | Information about the current page. |
| `total` | [CountInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-countinfo) | The total count of items matching the filter. |
PageInfo (entity)
Information about the current page in a paginated connection.
| Field | Type | Description |
| ----------------- | ---------- | ---------------------------------------------------------- |
| `hasNextPage` | `Boolean!` | Whether more items exist after the current page. |
| `hasPreviousPage` | `Boolean!` | Whether more items exist before the current page. |
| `startCursor` | `String` | The cursor pointing to the first item in the current page. |
| `endCursor` | `String` | The cursor pointing to the last item in the current page. |
***
## Mutations
### scheduleCreate
Creates a new schedule.
```graphql
scheduleCreate(
input: ScheduleCreateInput!
): SchedulePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ---------------------- | ------------------------------------------- |
| `input` | `ScheduleCreateInput!` | The input fields for creating the schedule. |
**Input types:**
ScheduleCreateInput
Input for creating a new schedule.
| Field | Type | Description |
| ---------------- | --------------- | -------------------------------------------- |
| `organizationId` | `ID!` | The organization that will own the schedule. |
| `title` | `String!` | The schedule display name. |
| `scheduleData` | `ScheduleData!` | The schedule data. |
**Output types:**
SchedulePayload
The result of a schedule mutation.
| Field | Type | Description |
| ---------- | --------------------------- | -------------------------------- |
| `schedule` | [Schedule](#type-schedule)! | The created or updated schedule. |
Schedule (entity)
A schedule definition for work hours, maintenance windows, or other time-based rules.
**Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#type-titled), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned)
| Field | Type | Description |
| -------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The human-readable display name. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization that owns this schedule. |
| `scheduleData` | `ScheduleData!` | The calendar and time interval definitions for this schedule. |
***
### scheduleUpdate
Updates an existing schedule.
```graphql
scheduleUpdate(
input: ScheduleUpdateInput!
): SchedulePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ---------------------- | ------------------------------------------- |
| `input` | `ScheduleUpdateInput!` | The input fields for updating the schedule. |
**Input types:**
ScheduleUpdateInput
Input for updating an existing schedule.
| Field | Type | Description |
| -------------- | -------------- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The schedule ID to update. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `scheduleData` | `ScheduleData` | The new schedule data. |
**Output types:**
SchedulePayload
The result of a schedule mutation.
| Field | Type | Description |
| ---------- | --------------------------- | -------------------------------- |
| `schedule` | [Schedule](#type-schedule)! | The created or updated schedule. |
Schedule (entity)
A schedule definition for work hours, maintenance windows, or other time-based rules.
**Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#type-titled), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned)
| Field | Type | Description |
| -------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The human-readable display name. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization that owns this schedule. |
| `scheduleData` | `ScheduleData!` | The calendar and time interval definitions for this schedule. |
***
### scheduleDelete
Deletes a schedule.
```graphql
scheduleDelete(
input: ScheduleDeleteInput!
): DeletePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ---------------------- | ------------------------------------------- |
| `input` | `ScheduleDeleteInput!` | The input fields for deleting the schedule. |
**Input types:**
ScheduleDeleteInput
Input for deleting a schedule.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The schedule ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
**Output types:**
DeletePayload
The result of a delete mutation.
| Field | Type | Description |
| ----------- | ----- | ----------------------------- |
| `deletedId` | `ID!` | The ID of the deleted entity. |
***
## Objects
### Schedule
A schedule definition for work hours, maintenance windows, or other time-based rules.
**Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#type-titled), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned)
| Field | Type | Description |
| -------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The human-readable display name. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization that owns this schedule. |
| `scheduleData` | `ScheduleData!` | The calendar and time interval definitions for this schedule. |
***
### SchedulePayload
The result of a schedule mutation.
| Field | Type | Description |
| ---------- | --------------------------- | -------------------------------- |
| `schedule` | [Schedule](#type-schedule)! | The created or updated schedule. |
***
## Inputs
### ScheduleFilter
Filtering options for schedules.
| Field | Type | Description |
| --------------- | -------- | --------------------------------------------------- |
| `titleContains` | `String` | Partial match on title (case-insensitive contains). |
***
### ScheduleOrder
Ordering options for schedules.
| Field | Type | Description |
| ----------- | ----------------------------------------------------------------------------------------------- | ------------------------------- |
| `field` | [ScheduleOrderField](#type-scheduleorderfield) | The standard field to order by. |
| `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. |
***
### ScheduleCreateInput
Input for creating a new schedule.
| Field | Type | Description |
| ---------------- | --------------- | -------------------------------------------- |
| `organizationId` | `ID!` | The organization that will own the schedule. |
| `title` | `String!` | The schedule display name. |
| `scheduleData` | `ScheduleData!` | The schedule data. |
***
### ScheduleUpdateInput
Input for updating an existing schedule.
| Field | Type | Description |
| -------------- | -------------- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The schedule ID to update. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `scheduleData` | `ScheduleData` | The new schedule data. |
***
### ScheduleDeleteInput
Input for deleting a schedule.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The schedule ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
***
## Enums
### ScheduleOrderField
Fields available for ordering schedules.
| Value | Description |
| ------- | --------------- |
| `TITLE` | Order by title. |
***
## Scalars
### ScheduleData
A schedule data structure containing time intervals and recurrence rules.
| Property | Value |
| ------------- | ------------------------------------------------------------- |
| Format | `iCalendar-compatible JSON` |
| Example | `{"intervals": [...], "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR"}` |
| Specification | |
***
## Pagination types
### ScheduleConnection
A paginated list of Schedule items.
**Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection)
| Field | Type | Description |
| ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| `edges` | \[[ScheduleEdge](#type-scheduleedge)!]! | A list of edges. |
| `nodes` | \[[Schedule](#type-schedule)!]! | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-pageinfo)! | Information about the current page. |
| `total` | [CountInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-countinfo) | The total count of items matching the filter. |
***
### ScheduleEdge
An edge in the Schedule connection.
**Implements:** [Edge](/docs/navixy-repository-api/core-api-reference/common.md#type-edge)
| Field | Type | Description |
| -------- | --------------------------- | ------------------------------------ |
| `cursor` | `String!` | An opaque cursor for this edge. |
| `node` | [Schedule](#type-schedule)! | The schedule at the end of the edge. |
***
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://navixy.com/docs/navixy-repository-api/core-api-reference/schedules.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.