> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List schedules

> List your crew schedules with their last and next run.



## OpenAPI

````yaml get /api/crew-schedules
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/crew-schedules:
    get:
      tags:
        - Crew schedules
      summary: List schedules
      description: List your crew schedules with their last and next run.
      operationId: list_schedules_api_crew_schedules_get
      parameters:
        - name: everyone
          in: query
          required: false
          schema:
            type: boolean
            description: List everyone's schedules. Needs `nx1_crew_admin`.
            default: false
            title: Everyone
          description: List everyone's schedules. Needs `nx1_crew_admin`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrewScheduleResponse'
                title: Response List Schedules Api Crew Schedules Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    CrewScheduleResponse:
      properties:
        id:
          type: string
          title: Id
        template_id:
          type: string
          title: Template Id
        template_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Template Name
          description: Null if the template can no longer be read.
        name:
          type: string
          title: Name
        owner_id:
          type: string
          title: Owner Id
          description: Username of the user the schedule belongs to.
        run_as_kind:
          type: string
          title: Run As Kind
          description: '`owner`: runs act as the owner. `identity`: as a service identity.'
          default: owner
        run_as:
          anyOf:
            - type: string
            - type: 'null'
          title: Run As
          description: >-
            Username its runs act as: the owner's, or the service identity's
            service account. Null if that identity no longer exists.
        run_as_identity_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Run As Identity Id
          description: The service identity it runs as, if any.
        cron:
          type: string
          title: Cron
        timezone:
          type: string
          title: Timezone
        task_input:
          additionalProperties: true
          type: object
          title: Task Input
        enabled:
          type: boolean
          title: Enabled
        next_run_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Run At
          description: Next slot (ISO 8601, UTC). Null while disabled.
        last_run_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Run At
          description: When a slot last fired or was skipped (UTC).
        last_run_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Run Id
          description: Crew-run id of the last run it started.
        last_run_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Run Status
          description: 'Status of that run: pending, running, completed or failed.'
        last_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Error
          description: Why the last slot did not start a run.
        is_owner:
          type: boolean
          title: Is Owner
          description: Whether the caller owns this schedule.
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
        - id
        - template_id
        - name
        - owner_id
        - cron
        - timezone
        - task_input
        - enabled
        - is_owner
        - created_at
        - updated_at
      title: CrewScheduleResponse
      description: A crew schedule with its last and next run.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.