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

# Get Beneficiaries List

> Get VertoFX Beneficiaries

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**Endpoint:** `/integrations/vertofx/beneficiaries`
**Method:** `GET`

**Query Parameters:**

| Parameter | Type | Description                                  |
| --------- | ---- | -------------------------------------------- |
| page      | Int  | The page number to retrieve (default: 1)     |
| size      | Int  | The number of records per page (default: 10) |

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/integrations/vertofx/beneficiaries', {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${token}`,
    },
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
    'https://api.royalti.io/integrations/vertofx/beneficiaries',
    headers={
      'Authorization': f'Bearer {token}'
    },
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X GET https://api.royalti.io/integrations/vertofx/beneficiaries \
    -H "Authorization: Bearer YOUR_TOKEN" \

  ```
</CodeGroup>


## OpenAPI

````yaml get /integrations/vertofx/beneficiaries
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /integrations/vertofx/beneficiaries:
    get:
      tags:
        - VertoFx
      summary: Get Beneficiaries List
      description: |-
        Get VertoFX Beneficiaries

        **Endpoint:** `/integrations/vertofx/beneficiaries`
        **Method:** `GET`

        **Query Parameters:**

        | Parameter | Type | Description |
        | --- | --- | --- |
        | page | Int | The page number to retrieve (default: 1) |
        | size | Int | The number of records per page (default: 10) |
      parameters:
        - name: page
          in: query
          required: false
          description: The page number to retrieve
          schema:
            type: integer
            default: 1
        - name: size
          in: query
          required: false
          description: The number of records per page
          schema:
            type: integer
            default: 10
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        accountNumber:
                          type: string
                        bankName:
                          type: string
                        beneficiaryAddress:
                          type: string
                        beneficiaryCity:
                          type: string
                        beneficiaryCompanyName:
                          type: string
                          nullable: true
                        beneficiaryCountryCode:
                          type: string
                        beneficiaryEntityType:
                          type: string
                        beneficiaryPostcode:
                          type: string
                        beneficiaryEmail:
                          type: string
                          nullable: true
                        country:
                          type: string
                        reference:
                          type: string
                        currency:
                          type: string
                        firstName:
                          type: string
                        lastName:
                          type: string
                        linkedUserId:
                          type: string
                          nullable: true
              example:
                success: true
                data:
                  - id: 4754
                    accountNumber: '2092805598'
                    bankName: United Bank for Africa Plc
                    beneficiaryAddress: PMB 2406 UBA House, 57, Marina
                    beneficiaryCity: Lagos
                    beneficiaryCompanyName: null
                    beneficiaryCountryCode: NG
                    beneficiaryEntityType: individual
                    beneficiaryPostcode: ''
                    beneficiaryEmail: null
                    country: NIGERIA
                    reference: RP-22042024-006
                    currency: NGN
                    firstName: John
                    lastName: Doe
                    linkedUserId: null
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````