# show

Endpoint: GET /api/agent_schedules/{id}
Version: 1.0.0
Security: ApiKeyAuth

## Path parameters:

  - `id` (string, required)
    Example: "00000000-0000-0000-0000-000000000001"

## Query parameters:

  - `include` (string)
    Example: "agent"

## Response 200 fields (application/vnd.api+json):

  - `data` (object, required)

  - `data.id` (string, required)

  - `data.type` (string, required)

  - `data.links` (object, required)

  - `data.links.self` (string, required)

  - `data.attributes` (object, required)

  - `data.attributes.createdAt` (string, required)

  - `data.attributes.updatedAt` (string, required)

  - `data.attributes.projectId` (string, required)

  - `data.attributes.agentId` (string, required)

  - `data.attributes.formInterfaceId` (string,null, required)

  - `data.attributes.chatInterfaceId` (string,null, required)

  - `data.attributes.interfaceType` (string, required)
    Enum: "form", "chat"

  - `data.attributes.name` (string, required)

  - `data.attributes.description` (string,null, required)

  - `data.attributes.status` (string, required)
    Enum: "active", "paused", "disabled"

  - `data.attributes.repeatUnit` (string, required)
    Enum: "no_repeat", "daily", "weekly", "monthly"

  - `data.attributes.repeatFrequency` (integer, required)

  - `data.attributes.repeatSubFrequency` (array, required)

  - `data.attributes.timezone` (string, required)

  - `data.attributes.startAt` (string, required)

  - `data.attributes.endAt` (string,null, required)

  - `data.attributes.parameterValues` (object, required)

  - `data.attributes.parameterValues.param1` (string)

  - `data.attributes.parameterValues.test_param` (string)

  - `data.attributes.sendEmailNotification` (boolean, required)

  - `data.attributes.emailRecipients` (array, required)

  - `data.attributes.textResourceId` (string,null, required)

  - `data.attributes.workflowProjectId` (string,null, required)

  - `data.attributes.workflowSessionId` (string,null, required)

  - `data.attributes.workflowAttemptId` (string,null, required)

  - `data.attributes.lastExecutedAt` (string,null, required)

  - `data.attributes.executionCount` (integer, required)

  - `data.attributes.lastRunStatus` (string,null, required)
    Enum: "success", "failure"

  - `data.attributes.lastRunErrorMessage` (string,null, required)

  - `data.relationships` (object)

  - `data.relationships.project` (object)

  - `data.relationships.project.data` (object, required)

  - `data.relationships.project.data.type` (string, required)

  - `data.relationships.project.data.id` (string, required)

  - `data.relationships.createdBy` (object)

  - `data.relationships.createdBy.data` (object, required)

  - `data.relationships.createdBy.data.type` (string, required)

  - `data.relationships.createdBy.data.id` (string, required)

  - `data.relationships.updatedBy` (object)

  - `data.relationships.updatedBy.data` (object, required)

  - `data.relationships.updatedBy.data.type` (string, required)

  - `data.relationships.updatedBy.data.id` (string, required)

  - `data.relationships.agent` (object)

  - `data.relationships.agent.data` (object, required)

  - `data.relationships.agent.data.type` (string, required)

  - `data.relationships.agent.data.id` (string, required)

  - `included` (array)

  - `included.id` (string, required)

  - `included.type` (string, required)

  - `included.links` (object,null)

  - `included.links.self` (string, required)

  - `included.attributes` (object, required)

  - `included.attributes.createdAt` (string,null)

  - `included.attributes.updatedAt` (string,null)

  - `included.attributes.name` (string, required)

  - `included.attributes.description` (any,null)

  - `included.attributes.useRuntimeTextResource` (boolean,null)

  - `included.attributes.useParentSegment` (boolean,null)

  - `included.attributes.useWorkflowExecutor` (boolean,null)

  - `included.attributes.isManaged` (boolean,null)

  - `included.attributes.managedType` (string,null)

  - `included.attributes.email` (string,null)

## Response 401 fields (application/json):

  - `status` (string, required)

  - `error` (string, required)

## Response 404 fields (application/vnd.api+json):

  - `errors` (array, required)

  - `errors.title` (string, required)

  - `errors.detail` (string, required)

  - `errors.code` (string, required)

  - `errors.status` (string, required)