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

# Get project details

> Fetch a single project (a job at one of the partner sites) by ID. Scoped to the partner the API key belongs to. Requires the `project:read` scope, and is available only to partners with access to ProVision Projects.



## OpenAPI

````yaml /openapi.yaml get /v1/project/{id}
openapi: 3.1.0
info:
  title: ProVision Public API
  version: 1.0.0
  description: >-
    Use the ProVision Public API to integrate with ProVision conversations,
    clients, users, and addresses. All endpoints accept and return JSON, are
    authenticated with an `x-api-key` header, and are scoped to a single partner
    tenant.
  contact:
    email: support@onevisionresources.com
    name: OneVision Resources Support
  license:
    name: Proprietary
servers:
  - url: https://connect.provisionapp.io
    description: Production
security: []
paths:
  /v1/project/{id}:
    get:
      tags:
        - project
      summary: Get project details
      description: >-
        Fetch a single project (a job at one of the partner sites) by ID. Scoped
        to the partner the API key belongs to. Requires the `project:read`
        scope, and is available only to partners with access to ProVision
        Projects.
      operationId: getProject
      parameters:
        - schema:
            allOf:
              - $ref: '#/components/schemas/ProjectId'
              - example: ovprjid-22222222-2222-4222-8222-222222222222
          required: true
          description: Project id, of the form `ovprjid-<uuidv4>`.
          name: id
          in: path
      responses:
        '200':
          description: Project details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - OpenApiKeyAuth: []
components:
  schemas:
    ProjectId:
      type: string
      pattern: ^ovprjid-.*$
      description: Project id, of the form `ovprjid-<uuidv4>`.
      example: ovprjid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344
    Project:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ProjectId'
        siteId:
          type: string
        name:
          type:
            - string
            - 'null'
        isPrimary:
          type: boolean
        stage:
          $ref: '#/components/schemas/ProjectStage'
        estimatedDay1:
          type:
            - string
            - 'null'
          format: date
        day1StartDate:
          type:
            - string
            - 'null'
          format: date
        warrantyExpiration:
          type:
            - string
            - 'null'
          format: date
        signingDate:
          type:
            - string
            - 'null'
          format: date
      required:
        - id
        - siteId
        - name
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - error
    ProjectStage:
      type: string
      enum:
        - Proposal
        - Active Project
        - Service Client
        - Lost Proposal
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: NOT_FOUND
        message:
          type: string
          description: Human-readable error description
      required:
        - code
        - message
  securitySchemes:
    OpenApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Send the API key in the x-api-key header.

````

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