Prospect Business Data API

Accessing Prospect Data via the API

Written by AshLast update 1 year ago

 Prospect Data API

The Business Data API endpoint will enable full CRUD controls of business prospect data within Hyperise.

Adding a record via the API will return a record ID, which can then be used to apply that data to any Hyperise image.

To use the API, you must first create an API token in the Settings area and use this token with all api requests.

Base API URL:<your_token>

API Overview


  • GET /businesses - fetch list of businesses of api token owner user

  • GET /businesses/<id> - fetch business object by ID

  • POST /businesses - create new business object

  • PUT /businesses/<id> - update data for exists business

  • DELETE /businesses/<id> - delete business object

Business object field

'business_name' => 'required|max:255',
'business_address' => 'max:255',
'business_phone' => 'max:255',
'email' => 'required|email',
'website' => 'required|max:255,
'category' => 'max:255',
'logo' => 'URL or base64 based image source',
'phone' => 'max:255',
'first_name' => 'max:255',
'last_name' => 'max:255',
'title' => 'max:255',
'job_title' => 'max:255',
'gender' => 'in:male,female',
'profile_image' => 'URL or base64 based image source',
'lat' => 'max:255',
'long' => 'max:255',
'custom_image_1' => 'URL or base64 based image source',
'custom_image_2' => 'URL or base64 based image source',
'custom_image_3' => 'URL or base64 based image source',
'custom_text_1' => 'max:255',
'custom_text_2' => 'max:255',
'custom_text_3' => 'max:255',
'custom_text_4' => 'max:255',
'custom_text_4' => 'max:255'

Sample of business object Output

    "id": 201587,
    "business_name": "Hyperise",
    "business_address": "London",
    "business_phone": "",
    "email": "",
    "website": "",
    "logo": {
    "file_name": "images/csv_businesses/logos/2019/03/12/image_1552374585_5448.png",
     "url": "",
     "width": 329,
     "height": 329
    "phone": "",
    "title": "Mr.",
    "first_name": "Ian",
    "last_name": "Naylor",
    "gender": "male",
    "job_title": "Founder",
    "profile_image": {
    "file_name": "images/csv_businesses/profile_images/2019/03/12/image_1552374585_1215.jpeg",
    "url": "",
     "width": 225,
     "height": 225
    "created_at": "2019-03-12 07:09:45",
    "updated_at": "2019-03-12 07:09:45"

Once you have added prospect data via the API, add the API integration to your image template, to enable the image to use the data.

Select the added API integration to update the image URL, you will now be able to enrich the image, changing the ID from the API data in your image URL.

Example Image URL:<template_ID>/user-business-<record_ID_from_API>.png

Discover other Hyperise APIs:

  1. User Authentication - Authorise the API token.

  2. List Image Templates - List all active Image templates for the authorised user.

  3. Image Views - List the most recent personalised views for selected image.

  4. Short Links - Create personalised Short Links.

  5. Data Enrichment - provides enriched data from an email input.

Did this answer your question?