GET /promoters?page=&per=
List of promoters

Errors

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

Response

{
  'data': [
    {
      'id': '83314505-2802-47b6-bfbf-baba04beedba',
      'sequential_id': 404,
      'name': 'Horacio',
      'lastname': 'Delao',
      'matriname': 'Gamez',
      'full_name': 'Horacio Delao Gamez',
      'company': false,
      'company_name': null,
      'person_type': 'Persona física',
      'email': 'salvador@rohanhuels.name',
      'phone_number': '3349969535',
      'phone_number_extension': null,
      'mobile_number': '2998144885',
      'gender': 'male',
      'dob': null,
      'tax_number': null,
      'base_commission': '1.00',
      'organization_id': '1b75708d-1358-437f-8f46-e2cc24c9bf42',
      'investors_attracted': 0,
      'nationality': null,
      'translated_nationality': null,
      'active_investors_amount': {
        'mxn': '0.00'
      },
      'created_by_full_name': 'José Luis Duran Nava',
      'country': null,
      'country_translated': null,
      'is_financial_entity': false
    },
    ...
  ],
  'meta': {
    'count': 5
  }
}

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer

per
optional

Items per page

Validations:

  • Must be a Integer


GET /promoters/:id
Specific promoter

Errors

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

Response

{
  'data': {
    'id': '83314505-2802-47b6-bfbf-baba04beedba',
    'sequential_id': 404,
    'name': 'Horacio',
    'lastname': 'Delao',
    'matriname': 'Gamez',
    'full_name': 'Horacio Delao Gamez',
    'company': false,
    'company_name': null,
    'person_type': 'Persona física',
    'email': 'salvador@rohanhuels.name',
    'phone_number': '3349969535',
    'phone_number_extension': null,
    'mobile_number': '2998144885',
    'gender': 'male',
    'dob': null,
    'tax_number': null,
    'base_commission': '1.00',
    'organization_id': '1b75708d-1358-437f-8f46-e2cc24c9bf42',
    'investors_attracted': 0,
    'nationality': null,
    'translated_nationality': null,
    'active_investors_amount': {
      'mxn': '0.00'
    },
    'created_by_full_name': 'José Luis Duran Nava',
    'country': null,
    'country_translated': null,
    'is_financial_entity': false
  }
}

Params

Param name Description
id
required

Requested promoter ID

Validations:

  • Must be a String


GET /promoters/:id/prospections
Prospections from specific promoter

Errors

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

Response

{
  'data': [
    {
      'id': '3c97fd8b-66b9-421d-8a4e-e3a2706453f4',
      'sequential_id': 1512,
      'name': 'John',
      'lastname': 'Wick',
      'matriname': null,
      'full_name': 'John Wick ',
      'company': false,
      'company_name': null,
      'person_type': 'Persona física',
      'email': 'jazvi1998@gmail.com',
      'phone_number': '8261005160',
      'phone_number_extension': null,
      'mobile_number': '8121235060',
      'gender': 'male',
      'dob': '1999-07-07',
      'contact_date': '2021-07-01',
      'status': 'in_process',
      'status_translated': 'En proceso',
      'street': 'Calle 5a.',
      'street_number': 12,
      'street_number_internal': null,
      'postal_code': '66463',
      'city': 'San Nicolás de los Garza',
      'state': 'Nuevo Leon',
      'country': null,
      'suburb': null,
      'tentative_investment': {
        'mxn': 0
      },
      'tentative_rate': '12.00',
      'tentative_entry_date': null,
      'tentative_currency': 'mxn',
      'nationality': null,
      'promoter_id': '83314505-2802-47b6-bfbf-baba04beedba',
      'country_translated': null,
      'prospections': [],
      'promoter': { ... }
    }
  ],
  'meta': {
    'count': 1
  }
}

Params

Param name Description
id
required

Requested promoter ID

Validations:

  • Must be a String


GET /promoters/:id/investors
Investors from specific promoter

Also see investors#index.

Errors

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

Params

Param name Description
id
required

Requested promoter ID

Validations:

  • Must be a String