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

# Conventions list



## OpenAPI

````yaml /api-reference/partners/api.json get /v1/conventions
openapi: 3.1.0
info:
  title: Laravel
  version: 0.0.1
servers:
  - url: https://api.opx.co/partners
    description: Production
security: []
paths:
  /v1/conventions:
    get:
      tags:
        - Conventions
      summary: Conventions list
      operationId: partners.conventions.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
        - name: type
          in: query
          schema:
            type:
              - string
              - 'null'
            enum:
              - b2c
              - b2b
        - name: keyword
          in: query
          schema:
            type:
              - string
              - 'null'
        - name: start_date
          in: query
          schema:
            type:
              - string
              - 'null'
        - name: end_date
          in: query
          schema:
            type:
              - string
              - 'null'
        - name: commitment_date
          in: query
          schema:
            type:
              - string
              - 'null'
      responses:
        '200':
          description: '`ConventionCollection`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConventionCollection'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    ConventionCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConventionResource'
      required:
        - data
      title: ConventionCollection
    ConventionResource:
      type: object
      properties:
        id:
          type: integer
        contract_template_id:
          type: integer
        reference:
          type: string
        rai_name:
          type: string
        status:
          type: integer
        installer_name:
          type: string
        signed_date:
          type:
            - string
            - 'null'
        start_date:
          type: string
        end_date:
          type: string
        incentive_type:
          type: integer
        classic_volume:
          type:
            - string
            - 'null'
        precarity_volume:
          type:
            - string
            - 'null'
        is_active:
          type: boolean
        is_expired:
          type: string
      required:
        - id
        - contract_template_id
        - reference
        - rai_name
        - status
        - installer_name
        - signed_date
        - start_date
        - end_date
        - incentive_type
        - classic_volume
        - precarity_volume
        - is_active
        - is_expired
      title: ConventionResource
  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

````