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

# Beneficiaries list



## OpenAPI

````yaml /api-reference/partners/api.json get /v1/beneficiaries
openapi: 3.1.0
info:
  title: Laravel
  version: 0.0.1
servers:
  - url: https://api.opx.co/partners
    description: Production
security: []
paths:
  /v1/beneficiaries:
    get:
      tags:
        - Beneficiaries
      summary: Beneficiaries list
      operationId: partners.beneficiaries.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: convention_id
          in: query
          schema:
            type:
              - integer
              - 'null'
        - name: keyword
          in: query
          description: nécessaire lorque le chantier est crée par un mandataire
          schema:
            type:
              - string
              - 'null'
      responses:
        '200':
          description: '`BeneficiaryCollection`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryCollection'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    BeneficiaryCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BeneficiaryResource'
      required:
        - data
      title: BeneficiaryCollection
    BeneficiaryResource:
      type: object
      properties:
        id:
          type: integer
        firstname:
          type: string
        lastname:
          type: string
        company_name:
          type: string
        siren:
          type: string
        siret:
          type: string
        address:
          type: string
        city:
          type: string
        zipcode:
          type: string
        country:
          type: string
        mobile_phone:
          type: string
        phone:
          type: string
        email:
          type: string
      required:
        - id
        - firstname
        - lastname
        - company_name
        - siren
        - siret
        - address
        - city
        - zipcode
        - country
        - mobile_phone
        - phone
        - email
      title: BeneficiaryResource
  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

````