> ## 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.

# Gets a single project.

> Returns every field the project list returns, with the same values, plus the ones the list
leaves out: the project's `Description`, its `SharedWithContactIds` and its
`WatcherIds`.
            
A project's sections and tasks are their own sub-resources and are not embedded here - read
them from `GET /v1/projects/{projectId}/sections`.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}
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}:
    get:
      tags:
        - Projects
      summary: Gets a single project.
      description: "Returns every field the project list returns, with the same values, plus the ones the list\r\nleaves out: the project's `Description`, its `SharedWithContactIds` and its\r\n`WatcherIds`.\r\n            \r\nA project's sections and tasks are their own sub-resources and are not embedded here - read\r\nthem from `GET /v1/projects/{projectId}/sections`."
      operationId: get_v1_projects_projectId
      parameters:
        - name: projectId
          in: path
          description: Project identifier.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProjectDetailModelBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectDetailModelBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ProjectDetailModelBaseResponse'
        '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:
    ProjectDetailModelBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          $ref: '#/components/schemas/ProjectDetailModel'
        DataContext:
          type: object
          additionalProperties: false
          nullable: true
          example: null
        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
    ProjectDetailModel:
      type: object
      properties:
        Id:
          type: string
          description: Project identifier.
          format: uuid
        Title:
          type: string
          description: Project title.
        Number:
          type: integer
          description: Sequential project number.
          format: int64
          nullable: true
        DisplayNumber:
          type: string
          description: >-
            Human-readable project number, including any service-provider
            prefix.
        ClientId:
          type: integer
          description: Identifier of the client the project belongs to.
          format: int64
          nullable: true
        LocationId:
          type: integer
          description: Identifier of the client location the project belongs to.
          format: int64
          nullable: true
        LeadAssigneeId:
          type: integer
          description: Identifier of the lead assignee (technician).
          format: int64
          nullable: true
        GroupIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of the technician groups the project is assigned to.
        PrimaryGroupId:
          type: integer
          description: "Identifier of the primary technician group - the first entry of `GroupIds`, the\r\nsame reading a ticket's `PrimaryGroupId` uses. Null when the project has no group."
          format: int64
          nullable: true
        Status:
          $ref: '#/components/schemas/CodeModel'
        StatusUpdatedOn:
          type: string
          description: "Timestamp of the last status change (UTC). Null when no status change has been recorded\r\nfor the project."
          format: date-time
          nullable: true
        StatusReason:
          type: string
          description: Reason recorded for the current status, when applicable.
        Type:
          $ref: '#/components/schemas/GuidCodeModel'
        TagIds:
          type: array
          items:
            type: string
            format: uuid
          description: Identifiers of tags applied to the project.
        TargetDate:
          type: string
          description: Date the project is targeted to finish (UTC).
          format: date-time
          nullable: true
        ProgressPercent:
          type: number
          description: >-
            Percentage of the project's tasks that are complete, 0-100, rounded
            to two decimal places.
          format: float
          nullable: true
        LastUpdate:
          $ref: '#/components/schemas/ProjectLastUpdateModel'
        CreatedOn:
          type: string
          description: When the project was created (UTC).
          format: date-time
        UpdatedOn:
          type: string
          description: When the project was last updated (UTC).
          format: date-time
          nullable: true
        ClosedOn:
          type: string
          description: "When the project was closed (UTC) - set when it moves to Closed, cleared when it is\r\nreopened. Null for a project that is not Closed."
          format: date-time
          nullable: true
        Description:
          type: string
          description: Project description.
        SharedWithContactIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of contacts the project is shared with.
        WatcherIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of technicians watching the project.
      additionalProperties: false
      description: "A single project. Returns every field the project list returns, with the same values, plus the\r\nones the list leaves out. Sections are their own sub-resource\r\n(`GET /v1/projects/{projectId}/sections`) and are deliberately not embedded here."
    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.
    GuidCodeModel:
      type: object
      properties:
        Id:
          type: string
          description: Identifier of the coded value.
          format: uuid
          example: 0f6a1e1c-5f2b-4f1e-9a3d-2c6f1b7a4e10
        Name:
          type: string
          description: Display name of the coded value.
      additionalProperties: false
      description: "A resolved reference whose key is a GUID rather than a number - the same `{ Id, Name }`\r\nshape as `PublicCodeModel`. Used for tenant-configured values such as a\r\nproject's type."
    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.
  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.