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

# Lists a project's tasks.

> Ordered by the board's own ordering by default, so the response matches what the app
shows. The locked contract's `assignedToMe` is not offered: the gateway strips
every technician identifier, so "me" would resolve to nobody and the filter would match
nothing for every key. Use assigneeIds instead.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/tasks
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/projects/{projectId}/tasks:
    get:
      tags:
        - Projects
      summary: Lists a project's tasks.
      description: "Ordered by the board's own ordering by default, so the response matches what the app\r\nshows. The locked contract's `assignedToMe` is not offered: the gateway strips\r\nevery technician identifier, so \"me\" would resolve to nobody and the filter would match\r\nnothing for every key. Use assigneeIds instead."
      operationId: get_v1_projects_projectId_tasks
      parameters:
        - name: projectId
          in: path
          description: Project whose tasks to list.
          required: true
          schema:
            type: string
            format: uuid
        - name: Cursor
          in: query
          description: >-
            Opaque pagination cursor from a previous page; omit for the first
            page.
          schema:
            type: string
        - name: PageSize
          in: query
          description: >-
            Number of items per page, 1-200 (default 50). Out of range is
            rejected, not clamped.
          schema:
            type: integer
            format: int32
            default: 50
        - name: SortBy
          in: query
          description: 'Sort field: `boardOrder` (default), `createdOn` or `updatedOn`.'
          schema:
            type: string
            default: boardOrder
        - name: SortOrder
          in: query
          description: 'Sort direction: `asc` (default) or `desc`.'
          schema:
            type: string
            default: asc
        - name: SectionIds
          in: query
          description: Comma-separated section ids (Guids).
          schema:
            type: string
        - name: StatusIds
          in: query
          description: >-
            Comma-separated task status ids: 1 Not started, 2 Working on it, 3
            On hold, 4 Done. Any other id is a 400. Omitted returns every
            status.
          schema:
            type: string
        - name: AssigneeIds
          in: query
          description: >-
            Comma-separated technician ids; matches a task's lead or assisting
            assignees.
          schema:
            type: string
        - name: LeadAssigneeIds
          in: query
          description: Comma-separated technician ids; matches a task's lead assignee only.
          schema:
            type: string
        - name: IncompleteOnly
          in: query
          description: When true, drops tasks in the Done status.
          schema:
            type: boolean
            default: false
        - name: DueAfter
          in: query
          description: >-
            Keeps only tasks due at or after this instant (UTC). A task with no
            due date matches neither bound.
          schema:
            type: string
            format: date-time
        - name: DueBefore
          in: query
          description: Keeps only tasks due strictly before this instant (UTC).
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/TaskListItemModelListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TaskListItemModelListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TaskListItemModelListBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    TaskListItemModelListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/TaskListItemModel'
          nullable: true
        DataContext:
          $ref: '#/components/schemas/PaginationDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    TaskListItemModel:
      type: object
      properties:
        Id:
          type: string
          description: Task identifier.
          format: uuid
        Title:
          type: string
          description: Task title.
        Number:
          type: integer
          description: Sequential task number within the project.
          format: int64
          nullable: true
        DisplayNumber:
          type: string
          description: "Human-readable task number, the project's display number and the task number joined —\r\ne.g. `PRO-462-3`."
        SectionId:
          type: string
          description: Identifier of the section the task sits in.
          format: uuid
        LeadAssigneeId:
          type: integer
          description: Identifier of the lead assignee.
          format: int64
          nullable: true
        AssistingAssigneeIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of assisting assignees.
        WatcherIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of technicians watching the task.
        PrimaryGroupId:
          type: integer
          description: "Identifier of the primary technician group. A task has no groups of its own - it inherits\r\nthem from its parent project - so this is the first entry of the project's\r\n`GroupIds`, the same reading a ticket's `PrimaryGroupId` uses. Null when the\r\nproject has no groups."
          format: int64
          nullable: true
        Status:
          $ref: '#/components/schemas/CodeModel'
        StatusUpdatedOn:
          type: string
          description: When the current status was last set (UTC).
          format: date-time
          nullable: true
        StatusReason:
          type: string
          description: Free-text reason recorded for the current status.
        Priority:
          $ref: '#/components/schemas/CodeModel'
        DueDate:
          type: string
          description: Date the task is due (UTC).
          format: date-time
          nullable: true
        ChecklistSummary:
          $ref: '#/components/schemas/TaskChecklistSummaryModel'
        IsUnread:
          type: boolean
          description: Whether the task is currently unread.
        IsWaitingOnThem:
          type: boolean
          description: >-
            Whether the task is waiting on the client rather than on the service
            provider.
        BlockedByTaskIds:
          type: array
          items:
            type: string
            format: uuid
          description: Identifiers of tasks that must finish before this one can.
        BlockingTaskIds:
          type: array
          items:
            type: string
            format: uuid
          description: Identifiers of tasks this one is blocking.
        LastUpdate:
          $ref: '#/components/schemas/ProjectLastUpdateModel'
        CreatedOn:
          type: string
          description: When the task was created (UTC).
          format: date-time
          nullable: true
        UpdatedOn:
          type: string
          description: When the task was last updated (UTC).
          format: date-time
          nullable: true
        ClosedOn:
          type: string
          description: "When the task was marked Done (UTC). Null whenever the task's current status is not Done:\r\nunlike a reopened ticket's `ClosedOn`, it reports the current close, not the last one\r\never recorded."
          format: date-time
          nullable: true
      additionalProperties: false
      description: A task as returned by the project's task list. All timestamps are UTC.
    PaginationDataContext:
      type: object
      properties:
        Pagination:
          $ref: '#/components/schemas/PaginatedResponse'
      additionalProperties: false
      description: "The `DataContext` of a cursor-paginated success response: carries the paging metadata\r\nfor the returned page."
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
    CodeModel:
      type: object
      properties:
        Id:
          type: integer
          description: >-
            Numeric identifier of the coded value (e.g. status, priority, type,
            or source id).
          format: int64
          example: 1
        Name:
          type: string
          description: Display name of the coded value.
      additionalProperties: false
      description: >-
        A coded value, such as a status, priority, type or source, as an id and
        a display name.
    TaskChecklistSummaryModel:
      type: object
      properties:
        Completed:
          type: integer
          description: Number of completed checklist items.
          format: int32
        Total:
          type: integer
          description: Total number of checklist items.
          format: int32
        ProgressPercent:
          type: number
          description: Percentage complete, 0-100, rounded to two decimal places.
          format: float
          nullable: true
      additionalProperties: false
      description: >-
        How many checklist items are done out of the total, across a task's
        checklists.
    ProjectLastUpdateModel:
      type: object
      properties:
        UpdateType:
          type: string
          description: "Type of the last update, from a fixed set. Empty, with an empty `Summary`, for any\r\nother recorded event.\r\n\n\r\nOn a project: `ProjectCreated`, `ProjectSectionCreated`,\r\n`ProjectSectionUpdated`, `ProjectSectionDeleted`, `TaskCreated`,\r\n`TaskSectionUpdated`, `TaskStatusUpdated`, `TaskDeleted`,\r\n`ProjectLeadAssigneeUpdated`, `ProjectContactsUpdated`, `ProjectDueDateUpdated`,\r\n`ProjectTypeUpdated`, `ProjectTagsUpdated`, `ProjectGroupsUpdated`,\r\n`ProjectStatusUpdated`, `ProjectCommentAdded`, `ProjectDeleted`,\r\n`ProjectRecovered`, `ProjectTitleUpdated`, `ProjectWatchersUpdated`,\r\n`ProjectClientUpdated`, `ProjectClientLocationUpdated`,\r\n`ProjectDescriptionUpdated`.\r\n\n\r\nOn a task: `TaskCreated`, `TaskSectionUpdated`, `TaskDeleted`,\r\n`TaskStatusUpdated`, `TaskPriorityUpdated`, `TaskDueDateUpdated`,\r\n`TaskLeadAssigneeUpdated`, `TaskAssistingAssigneesUpdated`, `TaskAssetsUpdated`,\r\n`TaskBlockersUpdated`, `TaskReadStatusUpdated`, `TaskTPCAdded`,\r\n`TaskShipmentTrackingAdded`, `TaskShipmentTrackingDeleted`,\r\n`TaskShipmentTrackingUpdated`, `TaskChecklistAdded`, `TaskChecklistDeleted`,\r\n`TaskChecklistItemAdded`, `TaskChecklistItemDeleted`,\r\n`TaskChecklistItemCompleted`, `TaskApprovalAdded`, `TaskCommentAdded`,\r\n`TaskTitleUpdated`, `TaskWatchersUpdated`, `TaskRecovered`, `TaskMerged`,\r\n`ProjectShortcutApplied`, `TaskDeviceFileExplorerUsed`,\r\n`TaskDeviceRemoteConnectLaunched`, `TaskEventScheduled`, `TaskEventRemoved`.\r\n"
        Summary:
          type: string
          description: >-
            Short plain-text summary of the last update. Empty when the event
            type carries no summary.
        'On':
          type: string
          description: When the last update happened (UTC).
          format: date-time
          nullable: true
      additionalProperties: false
      description: The most recent activity recorded on a project.
    PaginatedResponse:
      type: object
      properties:
        NextCursor:
          type: string
          nullable: true
        PreviousCursor:
          type: string
          nullable: true
        HasMore:
          type: boolean
        HasPrevious:
          type: boolean
        TotalCount:
          type: integer
          format: int32
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

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