v2

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer

per
optional

Items per page

Validations:

  • Must be a Integer

Examples

{
  'data': [
    {
      'id': 'promoter-uuid',
      'sequential_id': 1,
      'name': 'Test',
      'lastname': 'User',
      'matriname': 'Example',
      'full_name': 'Test User Example',
      'company': false,
      'company_name': null,
      'person_type': 'Persona física',
      'email': 'test@example.com',
      'phone_number': '5551234567',
      'phone_number_extension': null,
      'mobile_number': '5559876543',
      'gender': 'other',
      'dob': '1990-01-01',
      'tax_number': 'TAX123456',
      'base_commission': '2.00',
      'organization_id': 'org-uuid',
      'investors_attracted': 3,
      'nationality': 'test_nationality',
      'translated_nationality': 'Test Nationality',
      'active_investors_amount': {
        'mxn': '1000.00',
        'usd': '500.00'
      },
      'created_at': '2026-01-01 - 10:00',
      'updated_at': '2026-01-02 - 12:00',
      'created_by_full_name': 'Test Admin',
      'country': 'MEX',
      'country_translated': 'México',
      'is_financial_entity': false,
      'subsidiary_id': 'subsidiary-uuid',
      'extra_fields_attributes': [
        {
          'id': 'extra-field-uuid',
          'value': 'Test Value',
          'label': 'Test Label',
          'input_type': 'text',
          'options': ['Option 1', 'Option 2'],
          'key': 'key_TEST'
        }
      ],
      'subsidiary_name': 'Test Subsidiary'
    }
  ],
  'meta': {
    'count': 1
  }
}

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error