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

# Worksites list



## OpenAPI

````yaml /api-reference/partners/api.json get /v1/worksites
openapi: 3.1.0
info:
  title: Laravel
  version: 0.0.1
servers:
  - url: https://api.opx.co/partners
    description: Production
security: []
paths:
  /v1/worksites:
    get:
      tags:
        - Worksites
      summary: Worksites list
      operationId: partners.worksites.index
      parameters:
        - name: page
          in: query
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
        - name: per_page
          in: query
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: '`WorksiteCollection`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorksiteCollection'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    WorksiteCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorksiteResource'
      required:
        - data
      title: WorksiteCollection
    WorksiteResource:
      type: object
      properties:
        id:
          type: integer
        reference:
          type: string
        external_reference:
          type:
            - string
            - 'null'
        convention_id:
          type: integer
        beneficiary_id:
          type: integer
        installer_name:
          type: string
        zipcode:
          type: string
        address:
          type: string
        city:
          type: string
        status:
          type: string
        created_at:
          type: string
        precarity_type:
          type: string
        fiscal_informations:
          $ref: '#/components/schemas/FiscalDeclarationCollection'
        indivision:
          type: boolean
      required:
        - id
        - reference
        - external_reference
        - convention_id
        - beneficiary_id
        - installer_name
        - zipcode
        - address
        - city
        - status
        - created_at
        - precarity_type
        - fiscal_informations
        - indivision
      title: WorksiteResource
    FiscalDeclarationCollection:
      type: array
      items:
        $ref: '#/components/schemas/FiscalDeclarationResource'
      title: FiscalDeclarationCollection
    FiscalDeclarationResource:
      type: object
      properties:
        firstname:
          type: string
        lastname:
          type: string
        fiscal_number:
          type: string
        fiscal_reference:
          type: string
      required:
        - firstname
        - lastname
        - fiscal_number
        - fiscal_reference
      title: FiscalDeclarationResource
  responses:
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors

````