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': 'prospect-uuid',
      'sequential_id': 1,
      'name': 'Test',
      'lastname': 'Prospect',
      'matriname': 'Example',
      'full_name': 'Test Prospect Example',
      'company': false,
      'company_name': null,
      'person_type': 'Persona física',
      'email': 'prospect@example.com',
      'tentative_investment': {
        'mxn': '0.00',
        'usd': '0.00'
      },
      'max_status': 'En proceso',
      'phone_number': '5500000000',
      'phone_number_extension': '5500000000',
      'mobile_number': '5500000000',
      'gender': 'other',
      'dob': '1990-01-01',
      'contact_date': null,
      'street': null,
      'street_number': null,
      'street_number_internal': null,
      'postal_code': null,
      'city': null,
      'state': null,
      'country': null,
      'suburb': null,
      'created_at': '2026-04-30 - 10:00',
      'updated_at': '2026-04-30 - 12:00',
      'created_by_full_name': 'Name Example',
      'nationality': null,
      'translated_nationality': null,
      'commentary': 'Comment example',
      'promoter_id': 'promoter-uuid',
      'country_translated': null,
      'prospections': [
        {
          'id': 'prospections-uuid',
          'sequential_id': 1,
          'initial_amount': '1000000.00',
          'type_of': 'promissory_note',
          'status': 'in_process',
          'status_translated': 'En proceso',
          'start_date': '2026-04-01',
          'end_date': '2027-04-30',
          'currency': {
            'name': 'MXN',
            'value': 'mxn'
          },
          'interest_rate': '29.00',
          'includes_external_rate': false,
          'external_rate_label': null,
          'interest_rate_floor': null,
          'interest_rate_ceiling': null,
          'commentary': 'Test prospection commentary',
          'promoter': {
            'id': 'promoter-uuid',
            'full_name': 'Test Promoter'
          },
          'investor': null,
          'tentative_investment_mxn': '1000000.00',
          'tentative_investment_usd': 0,
          'promissory_duration_months': null,
          'minimum_term_months': null,
          'extra_fields_attributes': []
        }
      ],
      'promoter': {
        '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