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

# List projects

> List the projects belonging to the partner the API key belongs to. Supports pagination (`limit`, `offset`), full-text `search` over project names, `filters` (a URL-encoded JSON array of `{ attribute, operator, value }` conditions) and `sort`. Projects are linked to their site through `siteId`. Requires the `project:read` scope, and is available only to partners with access to ProVision Projects.



## OpenAPI

````yaml /openapi.yaml get /v1/project/list
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/list:
    get:
      tags:
        - project
      summary: List projects
      description: >-
        List the projects belonging to the partner the API key belongs to.
        Supports pagination (`limit`, `offset`), full-text `search` over project
        names, `filters` (a URL-encoded JSON array of `{ attribute, operator,
        value }` conditions) and `sort`. Projects are linked to their site
        through `siteId`. Requires the `project:read` scope, and is available
        only to partners with access to ProVision Projects.
      operationId: listProjects
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          required: false
          name: limit
          in: query
        - schema:
            type:
              - integer
              - 'null'
            minimum: 0
            default: 0
          required: false
          name: offset
          in: query
        - schema:
            type: string
          required: false
          name: search
          in: query
        - schema:
            type: string
            description: >-
              A URL-encoded JSON array of filter conditions, all AND-ed
              together. Each condition is `{ "attribute", "operator", "value",
              "valueType"? }`. Allowed attributes: id, siteId, name, stage,
              isPrimary, estimatedDay1, day1StartDate, warrantyExpiration,
              signingDate. Allowed operators: =, !=, in, not_in, ilike,
              not_ilike, <, <=, >, >=, is_null, is_not_null. `value` is always a
              string; set `valueType` (one of boolean, number, number[], string,
              string[]) to coerce it — e.g. `"boolean"` for a true/false
              attribute or `"string[]"` for the `in` operator.
          required: false
          description: >-
            A URL-encoded JSON array of filter conditions, all AND-ed together.
            Each condition is `{ "attribute", "operator", "value", "valueType"?
            }`. Allowed attributes: id, siteId, name, stage, isPrimary,
            estimatedDay1, day1StartDate, warrantyExpiration, signingDate.
            Allowed operators: =, !=, in, not_in, ilike, not_ilike, <, <=, >,
            >=, is_null, is_not_null. `value` is always a string; set
            `valueType` (one of boolean, number, number[], string, string[]) to
            coerce it — e.g. `"boolean"` for a true/false attribute or
            `"string[]"` for the `in` operator.
          name: filters
          in: query
          examples:
            equals:
              summary: Exact match
              value: '[{"attribute":"id","operator":"=","value":"example"}]'
            anyOf:
              summary: Match any of several values (`in`)
              value: >-
                [{"attribute":"id","operator":"in","value":"a,b,c","valueType":"string[]"}]
            contains:
              summary: Case-insensitive contains (`ilike`)
              value: '[{"attribute":"id","operator":"ilike","value":"%term%"}]'
            isSet:
              summary: Attribute is not null (`is_not_null`)
              value: '[{"attribute":"id","operator":"is_not_null","value":""}]'
        - schema:
            type: string
            description: >-
              Comma-separated list of fields to sort by, applied in order;
              prefix a field with `-` for descending. Allowed fields: name,
              stage, estimatedDay1, day1StartDate, warrantyExpiration,
              signingDate.
          required: false
          description: >-
            Comma-separated list of fields to sort by, applied in order; prefix
            a field with `-` for descending. Allowed fields: name, stage,
            estimatedDay1, day1StartDate, warrantyExpiration, signingDate.
          name: sort
          in: query
          examples:
            descending:
              summary: Single field, descending
              value: '-name'
            multiple:
              summary: Multiple keys (first descending, then ascending)
              value: '-name,stage'
      responses:
        '200':
          description: Paginated list of projects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectList'
        '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:
    ProjectList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Project'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - data
        - meta
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - error
    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
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Total number of matching records
        limit:
          type: integer
          description: Page size used for this response
        offset:
          type: integer
          description: Offset used for this response
      required:
        - total
        - limit
        - offset
    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
    ProjectId:
      type: string
      pattern: ^ovprjid-.*$
      description: Project id, of the form `ovprjid-<uuidv4>`.
      example: ovprjid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344
    ProjectStage:
      type: string
      enum:
        - Proposal
        - Active Project
        - Service Client
        - Lost Proposal
  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.