---
updatedAt: 2026-06-12T14:47:10.000Z
agentTools:
  projectIndex: https://docs.formant.io/llms.txt
---

# Get one

Get a command schedule by command schedule ID.
Resource: schedules
Authorized roles: viewer

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "TheopolisConfiguration": {
        "properties": {
          "userId": {
            "format": "uuid",
            "type": "string"
          },
          "personaId": {
            "format": "uuid",
            "type": "string"
          },
          "description": {
            "maxLength": 1000,
            "type": "string"
          },
          "goal": {
            "maxLength": 2000,
            "type": "string"
          },
          "model": {
            "items": {
              "type": "string",
              "enum": [
                "o3",
                "o3-mini",
                "gpt-4.1-nano",
                "gpt-4.1-mini",
                "gpt-4.1",
                "gpt-5.1",
                "gpt-5",
                "gpt-5-mini",
                "gpt-5-nano",
                "claude-sonnet-4-20250514",
                "claude-opus-4-20250514",
                "claude-sonnet-4-5",
                "claude-opus-4-5-20251101",
                "claude-opus-4-6",
                "claude-sonnet-4-6",
                "claude-haiku-4-5",
                "gpt-5.4",
                "gpt-5.4-mini",
                "gpt-5.4-nano",
                "gpt-realtime-1.5",
                "ollama:llama3.1",
                "ollama:mistral",
                "ollama:qwen2.5-coder",
                "ollama:deepseek-r1"
              ]
            },
            "type": "string"
          }
        },
        "type": "object",
        "required": [
          "description",
          "goal"
        ],
        "nullable": true
      },
      "TaskFlowConfiguration": {
        "properties": {
          "userId": {
            "format": "uuid",
            "type": "string"
          },
          "taskFlowId": {
            "format": "uuid",
            "type": "string"
          },
          "input": {
            "maxLength": 20000,
            "type": "string"
          }
        },
        "type": "object",
        "nullable": true
      },
      "Schedule": {
        "properties": {
          "organizationId": {
            "format": "uuid",
            "type": "string",
            "description": "ID of the organization to which you want to add this new schedule."
          },
          "name": {
            "maxLength": 50,
            "type": "string",
            "description": "Name of this schedule."
          },
          "description": {
            "maxLength": 500,
            "type": "string",
            "description": "User-friendly description of this command schedule."
          },
          "type": {
            "type": "string",
            "enum": [
              "command",
              "run-workflow",
              "generate-insights",
              "compose-operation",
              "theopolis-task",
              "task-flow"
            ],
            "description": "Enter `command`."
          },
          "at": {
            "nullable": true,
            "format": "date-time",
            "type": "string",
            "description": "Timestamp at which this command should execute. Must be in the future. Format: `YYYY-MM-DDTHH:MM:SS`"
          },
          "cron": {
            "nullable": true,
            "type": "string",
            "description": "Frequency of this command schedule, as defined at https://crontab.guru"
          },
          "durationMs": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "maximum": 9007199254740991,
            "description": "Enter `0` for this parameter."
          },
          "timezone": {
            "type": "string",
            "description": "Timezone which corresponds to the timestamp provided in the `at` parameter, in `tz database` format."
          },
          "displayTimezone": {
            "nullable": true
          },
          "commandTemplateId": {
            "nullable": true,
            "format": "uuid",
            "type": "string",
            "description": "You must create a command template before you can schedule this command."
          },
          "composeOperationId": {
            "nullable": true,
            "format": "uuid",
            "type": "string",
            "description": "Runs theopolis task source."
          },
          "workflowId": {
            "maxLength": 1024,
            "type": "string",
            "nullable": true
          },
          "parameterValue": {
            "nullable": true,
            "maxLength": 1024,
            "type": "string",
            "description": "Value of the command parameter to be sent with this scheduled command."
          },
          "deviceId": {
            "format": "uuid",
            "type": "string",
            "description": "ID of the device to which to send this command."
          },
          "status": {
            "maxLength": 1000,
            "type": "string",
            "description": "Internal use only, ignore."
          },
          "theopolis": {
            "$ref": "#/components/schemas/TheopolisConfiguration",
            "nullable": true
          },
          "taskFlowConfiguration": {
            "$ref": "#/components/schemas/TaskFlowConfiguration",
            "nullable": true
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object",
        "required": [
          "name",
          "description",
          "type",
          "durationMs",
          "timezone",
          "deviceId",
          "at",
          "cron",
          "commandTemplateId",
          "parameterValue"
        ]
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "title": "Formant admin-api",
    "version": "1.357.8"
  },
  "openapi": "3.0.0",
  "paths": {
    "/schedules/{id}": {
      "get": {
        "operationId": "ScheduleController.getOne",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Schedule"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "Get one",
        "tags": [
          "Schedule"
        ],
        "description": "Get a command schedule by command schedule ID.\nResource: schedules\nAuthorized roles: viewer",
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.formant.io/v1/admin"
    }
  ]
}
```