Prospects
Prospects Endpoints

>>>

GET /prospects?page=&per=
List of Prospects

Errors

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

Response

{
  'data': [
    {
      'id': '75e7c18e-b545-4e3a-a0a9-3ec512a0c5fd',
      'sequential_id': 1511,
      'name': 'Luz',
      'lastname': 'de Anda',
      'matriname': 'Matos',
      'full_name': 'Luz de Anda Matos',
      'company': false,
      'company_name': null,
      'person_type': 'Persona física',
      'email': 'florindagreenfelder@feilskiles.name',
      'phone_number': '8131531449',
      'phone_number_extension': null,
      'mobile_number': '7325157406',
      'gender': 'other',
      'dob': '1975-12-21',
      'contact_date': '2020-08-31',
      'status': 'in_process',
      'status_translated': 'En proceso',
      'street': 'Sector Marcela',
      'street_number': '389',
      'street_number_internal': 'Esc. 245',
      'postal_code': '12345',
      'city': 'Castellón de la Plana',
      'state': 'Principado de Asturias',
      'country': 'USA',
      'suburb': null,
      'tentative_investment': {
        'mxn': 0
      },
      'tentative_rate': '34.00',
      'tentative_entry_date': '2021-06-07',
      'tentative_currency': 'mxn',
      'nationality': null,
      'promoter_id': '80317b88-4a1e-48ed-bdbe-81e65eddf7f3',
      'country_translated': 'United States',
      'prospections': [],
      'promoter': { ... }
    },
    ...
  ],
  'meta': {
    'count': 10
  }
}

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
>>>

GET /prospects/:id
Specific prospect

Errors

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

Response

 {
  'data': {
    'id': '75e7c18e-b545-4e3a-a0a9-3ec512a0c5fd',
    'sequential_id': 1511,
    'name': 'Luz',
    'lastname': 'de Anda',
    'matriname': 'Matos',
    'full_name': 'Luz de Anda Matos',
    'company': false,
    'company_name': null,
    'person_type': 'Persona física',
    'email': 'florindagreenfelder@feilskiles.name',
    'phone_number': '8131531449',
    'phone_number_extension': null,
    'mobile_number': '7325157406',
    'gender': 'other',
    'dob': '1975-12-21',
    'contact_date': '2020-08-31',
    'status': 'in_process',
    'status_translated': 'En proceso',
    'street': 'Sector Marcela',
    'street_number': '389',
    'street_number_internal': 'Esc. 245',
    'postal_code': '12345',
    'city': 'Castellón de la Plana',
    'state': 'Principado de Asturias',
    'country': 'USA',
    'suburb': null,
    'tentative_investment': {
      'mxn': 0
    },
    'tentative_rate': '34.00',
    'tentative_entry_date': '2021-06-07',
    'tentative_currency': 'mxn',
    'nationality': null,
    'promoter_id': '80317b88-4a1e-48ed-bdbe-81e65eddf7f3',
    'country_translated': 'United States',
    'prospections': [],
    'promoter': { ... }
  }
}

Params

Param name Description
id
required

Requested prospect ID

Validations:

  • Must be a String
>>>

GET /prospects/:id/prospections
Prospections from specific prospect

Errors

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

Response

{
  'data': [
    {
      'id': '104a414f-e22c-4219-8be9-1c36dbc320b7',
      'sequential_id': 1,
      'initial_amount': '1000000.0',
      'type_of': 'promissory_note',
      'status': 'standby',
      'status_translated': 'En espera',
      'start_date': '2021-07-01',
      'end_date': '2022-07-01',
      'currency': 'mxn',
      'interest_rate': '12.0',
      'includes_external_rate': false,
      'external_rate_label': null,
      'interest_rate_floor': null,
      'interest_rate_ceiling': null,
      'commentary': 'Some notes',
      'investor_id': null,
      'prospect': { ... },
      'society': { ... },
      'organization': { ... }
    }
  ],
  'meta': {
    'count': 1
  }
}

Params

Param name Description
id
required

Requested prospect ID

Validations:

  • Must be a String