Find Co-Founders & Employees Connect with {{ promotions.totalJobCandidates }} talented F6Sers

API Key

The Profile API uses an API key to identify your application. API keys are only available to organisations.

Profile API

Overview

The Profile API lets you request the data of F6S profiles (either people, startups, events, programs etc). The API call returns a JSON based on URL parameters sent through a standard HTTPS request.

Profile API request format

An Profile API request takes the following form:

https://api.f6s.com/PROFILE-NAME?api_key=API-KEY&parameters

where PROFILE-NAME is either the profile’s alias or actor-id.

Example: The alias of the profile Startup Labs - India is startuplabs-india. It can be found in the URL of the profile page. To get the actor-id of the profile Startup Labs - India, which has the url http://www.f6s.com/startuplabs-india, the user should type http://www.f6s.com/startuplabs-india/main/actor-id in the address bar.

Parameters are optional and may be used to get a specific size of the individual profile picture:

  • thumbnail_size=value : set the size of thumbnails returned by the response.

Thumbnail sizes:

  • uploaded - size of uploaded photo
  • original - original shape, 700px max side or less if picture is smaller
  • quad - original shape, 170px max side or less if picture is smaller
  • half - original shape, 350px max side or less if picture is smaller
  • small - original shape, 50px max side or less if picture is smaller
  • th1 - square, 140x140 px
  • th2 - square, 112x112 px
  • th3 - square, 64x64 px
  • th4 - square, 30x30 px
  • thumb - max width 130px or less if upload image width is smaller

Example: requesting information of the profile "Startup Program 2014"

The following example contains the URL of a JSON that contains all information about the Startup Program 2014 profile. The profile alias is startupprogram2014, so the URL to call the API is:

https://api.f6s.com/startupprogram2014?api_key=XXXXXX&parameters

When you send through this HTTPS request, the API returns a JSON like the following:

{
   "profile":{
      "id":"367579",
      "name":"Startup Program 2014",
      "description":"",
      "url":"https:\/\/www.f6s.com\/startupprogram2014",
      "location":{
         "country":"United States",
         "city":"San Francisco"
      },
      "company_name":"",
      "thumbnail":{
         "url":"https:\/\/a2d395efda2d9ae22eed-f575b268048dadb1e864e1e0f4419a39.ssl.cf1.rackcdn.com\/1234\/12345_th1.jpg",
         "image_id":"12345",
         "path":"pictures\/profiles\/50\/1234",
         "type":"jpg",
         "size":"th1",
         "mime_type":"image\/jpeg",
         "width":140,
         "height":140
      },
      "application_open":"2014-09-14 21:00:00",
      "application_close":"2014-10-15 20:59:00",
      "date_start":"2014-10-25 21:00:00",
      "date_end":"2014-10-28 20:59:00",
      "application_time_left":371281,
      "skills":[
      ],
      "links":[
         {
            "type":"website",
            "value":"europe.startupprogram.com"
         },
         {
            "type":"twitter",
            "value":"The Startup Program"
         },
         {
            "type":"facebook",
            "value":"www.facebook.com\/thestartupprogram"
         }
      ],
      "mentors":[
      ]
   },
   "status":200,
   "error":{
      "error_code":0
   }
}

Profile API results

When the Profile API returns results, it places them within a (JSON) array.

A typical result is made up of the following fields:

The profile[] is an array containing the separate profile components. Each profile[] typically contains:

  • id[] is an integer indicating the profile id.
  • name[] - string, is the name of the profile as shown in the profile URL.
  • description - string, is the profile description.
  • url - string, is the full URL of the profile.
  • location[] - array, shows the information about the location of the profile. It typically contains:
    • city - string, is the name of the city.
    • country - string, is the name of the country.
  • company_name - string, is the name of person's current workplace. It only shows if the requested profile is a person profile.
  • thumbnail contains all the information about the profile picture. It is an array containing the separate thumbnail objects. The array typically contains:
    • url is a string that displays the full URL of deal thumbnail with the selected size.
    • image_id - string, is the id of an image.
    • path - string, is the path part of URL to image folder.
    • type - string, is the file extension of an image (jpg,png,gif)
    • size - string, is the name of the re-sized image thumbnail. To see all the available sizes, check the thumbnail sizes section below.
    • mime_type is the mime type of the file.
    • width - integer, is the width in pixels of current re-sized copy of original image.
    • height - integer, is the height in pixels of current re-sized copy of original image.
  • application_open - date, is the date/time (GMT) when the application opens. It only shows if the requested profile is a program profile. It returns null if the program is already open.
  • application_close - date, is the date/time (GMT) when the application closes. It returns null if the program is already closed.
  • date_start - date, is the date/time (GMT) when the event or program starts. It returns null if the event has already started.
  • date_end - date, is the date/time (GMT) when the event or program ends. It returns null if the event has already ended.
  • application_time_left - time, is the time in seconds til application closes.
  • skills[] contains all the information about the profile skills and it's only available for person profiles. It is an array containing the separate skill objects. Each object typically contains:
    • id - integer, is the id of the skill.
    • name - string, is the english name of the skill.
    • root - boolean, indicates whether the skill is a root tag or not (1 = root, 0 = !root).
    • category_id - integer, is the ID of the category the tag belongs to. It is only available to people profiles.
    • category_name - string, is the name of the category the tag belongs to. It is only available to people profiles.
  • areas[] is an array of Areas (alias for category) the profile skills relate to. It is only available to people profiles.
  • links[] is an array of Link objects. It contains all the links that you find on the profile page (Facebook, LinkedIn, personal website etc). Each Link object typically contains:
    • type - string, is type of the link. The following values are currently supported:
      • facebook
      • linkedin
      • twitter
      • android
      • website
      • googleplus
    • value - string, is the full URL of the link.
  • mentors[] is array of basic Profile objects. It contains a list of the mentors related to the profile.

Profile Mentors API

Overview

The Profile Mentors API lets you request the F6S data of the profiles of Mentors associated with an organisation or a program. The API call returns a JSON array based on URL parameters sent through a standard HTTPS request.

Profile Mentors API request format

A Profile Mentors API request takes the following form:

https://api.f6s.com/PROFILE-NAME/mentors?api_key=API-KEY&page=CURRENT-PAGE&count=ITEMS-PER-PAGE

where:

  • PROFILE-NAME is either the profile’s alias or actor-id.

Example: The alias of the profile StartupProgram is startupprogram. It can be found in the URL of the profile page. To get the actor-id of the profile StartupProgram, which has the url https://www.f6s.com/startupprogram, the user should type https://www.f6s.com/startupprogram/main/actor-id in the address bar.

  • [ITEMS-PER-PAGE] (optional) is the maximum number of Mentors objects displayed per page. Default is 500.

  • [CURRENT-PAGE] (optional) is the page in pagination [1,2,3,…] where to make the request. Default is 1.

Example: requesting information about the mentors of the program “Startup Program 2014”

The following example contains the URL of a JSON that contains the information aboutthe Startup Program 2014 mentors. As shown in the profile URL https://www.f6s.com/startupprogram2014, the profile alias is startupprogram2014, so the URL to call the API is:

https://api.f6s.com/startupprogram2014/mentors?api_key=XXXXXX

When you send through this HTTPS request, the API returns a JSON like the following:

{
   "mentors":[
      {
         "id":"233168",
         "name":"John Foo",
         "description":"",
         "url":"https:\/\/www.f6s.com\/johnfoo",
         "company_name":"",
         "location":{
            "city":"Amsterdam",
            "country":"Netherlands"
         },
         "thumbnail":{
            "url":"https:\/\/55c3b1b662fd102d8c36-537e169a81c9aa004d4db2ad6e418d73.ssl.cf1.rackcdn.com\/1234\/338160_th1.jpg",
            "image_id":"338160",
            "path":"pictures\/profiles\/34\/1234",
            "type":"jpg",
            "size":"th1",
            "mime_type":"image\/jpeg",
            "width":140,
            "height":140
         },
         "skills":[
         ],
         "areas":[
         ],
         "links":[
         ],
         "mentor_of":[
            {
               "id":"226228",
               "name":"Startup Program 2014",
               "url":"https:\/\/www.f6s.com\/startupprogram2014",
               "thumbnail":{
                  "url":"https:\/\/e3c44beefaac02c29b37-900bbbeae83fefe2211d082e8a710734.ssl.cf1.rackcdn.com\/1234\/123456_th1.jpg",
                  "image_id":"123456",
                  "path":"pictures\/profiles\/47\/1234",
                  "type":"jpg",
                  "size":"th1",
                  "mime_type":"image\/jpeg",
                  "width":140,
                  "height":140
               }
            }
         ]
      },
   ],
   "status":200,
   "items_count":1,
   "total_items_count":1,
   "error":{
      "error_code":0
   }
}

Profile Mentors API results

When the Profile Mentors API returns results, it places them within a (JSON) array.

A typical result is made up of the following fields:

The mentor[] is an array containing the separate mentor objects. Each mentor[] typically contains:

  • id - integer, is the mentor profile id.
  • name - string, is the mentor name as shown in the Mentor Profile URL.
  • description - string, is the full mentor description.
  • url - string, is the full mentor profile URL.
  • location[] - array, shows the information about the location of the mentor. It typically contains:
    • city - string, is the name of the city.
    • country - string, is the name of the country.
  • company_name - string, is the name of the current workplace.
  • thumbnail[] contains all the information about the mentor profile picture. It is an array containing the separate thumbnail objects. The array typically contains:
    • url is a string that displays the full URL of deal thumbnail with the selected size.
    • image_id - string, is the id of an image.
    • path - string, is the path part of URL to image folder.
    • type - string, is the file extension of an image (jpg,png,gif)
    • size - string, is the name of the re-sized image thumbnail. To see all the available sizes, check the thumbnail sizes section below.
    • mime_type is the mime type of the file.
    • width - integer, is the width in pixels of current re-sized copy of original image.
    • height - integer, is the height in pixels of current re-sized copy of original image.
  • skills[] is an array of Skill objects. It contains a list of mentor skills.
  • areas[] is an array of Areas (alias for category) the mentor belongs to.
  • links[] - array of Link objects. List of mentor links
  • mentor_of[] is an array that contains basic information of the parent profiles. It shows the list of programs where the profile is involved as a mentor.

Accessory objects (not sure about the term ‘parameters’):

  • items_count - integer, is the number of mentors in current response mentors list.
  • total_items_count - integer, is the number of all mentors on all pages in current pagination
  • next - string, is the full URL of next page (if exists).
  • prev - string, is the full URL of previous page (if exists).
Note: The parameters next and prev will only appear if a previous or a next page exists in relationship with the mentor page that was taken in consideration. You could use the parameters prev and next to understand whether you need to make another API request in the same pagination.

Program/Event Startups API

Overview

The Program/Event Startups API lets you request the F6S data of the Startups associated with a Program or an Event. The API call returns a JSON array based on URL parameters sent through a standard HTTPS request.

Program/Event Startups API request format

A Program/Event Startups API request takes the following form:

https://api.f6s.com/PROFILE-NAME/teams?api_key=API-KEY&programs=PROGRAMS-LIST

Where:

  • PROFILE-NAME is either the parent program profile’s alias or actor-id.

  • PROGRAMS-LIST (optional) is a comma separated list of programs (accelerators) ids or names. If you use PROGRAMS-LIST when making the API request, you would limit the request to the programs that you listed, so you would get only the teams related to those programs.
Note: If you use `PROGRAMS-LIST`, be sure that `PROFILE-NAME` is a parent profile.

Example: requesting information about the startups that were part of the program “Startup Accelerator 2014”

The following example contains the URL of a JSON that contains the information about the startups that were part of Startup Accelerator 2014 program. Startup Accelerator 2014 is a child of Startup Accelerator, which has the URL https://www.f6s.com/startupaccelerator, so the PROFILE-NAME is startupaccelerator. Startup Accelerator 2014 has the URL https://www.f6s.com/startupaccelerator2014 so PROGRAMS-LIST is startupaccelerator2014. The URL to call the API is:

https://api.f6s.com/startupaccelerator/teams?api_key=XXXXXXX&programs=startupaccelerator2014

When you send through this HTTPS request, the API returns a JSON like the following:

{
   "teams":[
      {
         "id":"210894",
         "name":"GreatStartup",
         "blurb":"Increase your reach to over 400 million active social media users.",
         "description":"Driving business results with organic social media is hard. We automate that labor intensive process for you.",
         "url":"https:\/\/www.f6s.com\/greatstartup",
         "thumbnail":{
            "url":"https:\/\/1db44f7c4e39b2d86e7e-677cd5270e70f156b5d14a00d2ed7d35.ssl.cf1.rackcdn.com\/1234\/312165_th1.jpg",
            "image_id":"312165",
            "path":"pictures\/profiles\/32\/1234",
            "type":"jpg",
            "size":"th1",
            "mime_type":"image\/jpeg",
            "width":140,
            "height":140
         },
         "links":[
            {
               "type":"twitter",
               "value":"greatstartup"
            },
            {
               "type":"website",
               "value":"www.greatstartup.com"
            },
            {
               "type":"facebook",
               "value":"www.facebook.com\/greatstartup"
            },
            {
               "type":"linkedin",
               "value":"www.linkedin.com\/company\/123456"
            }
         ],
         "skills":[
            {
               "id":"155",
               "name":"Analytics"
            },
            {
               "id":"7425",
               "name":"Audience Measurement"
            },
            {
               "id":"4240",
               "name":"Social Marketing"
            },
            {
               "id":"1641",
               "name":"Social Media"
            },
            {
               "id":"1648",
               "name":"Social Media Marketing"
            }
         ],
         "members":[
            {
               "id":"210890",
               "name":"John Two",
               "url":"https:\/\/www.f6s.com\/johntwo",
               "thumbnail":{
                  "url":"https:\/\/1db44f7c4e39b2d86e7e-677cd5270e70f156b5d14a00d2ed7d35.ssl.cf1.rackcdn.com\/1234\/312159_th1.jpg",
                  "image_id":"312159",
                  "path":"pictures\/profiles\/32\/1234",
                  "type":"jpg",
                  "size":"th1",
                  "mime_type":"image\/jpeg",
                  "width":140,
                  "height":140
               }
            }
         ],
         "mentors":[
         ],
         "belongs_to_profile":[
            {
               "id":"328033",
               "name":"Startup Accelerator 2014",
               "url":"https:\/\/www.f6s.com\/startupaccelerator2014",
               "thumbnail":{
                  "url":"https:\/\/fc817b46e9ca51557163-e8bf86516306d20b00c4ee178f1a3d90.ssl.cf1.rackcdn.com\/568\/123456_th1.jpg",
                  "image_id":"123456",
                  "path":"pictures\/profiles\/6\/568",
                  "type":"jpg",
                  "size":"th1",
                  "mime_type":"image\/jpeg",
                  "width":140,
                  "height":140
               }
            }
         ]
      }
   ],
   "status":200,
   "error":{
      "error_code":0
   }
}
Note: If you want to call multiple child programs at the same time, just write their aliases separated by a comma. https://api.f6s.com/parentprogram/teams?api_key=XXXXXX&programs=program1,program2,program3

Program/Event Startups API results

When the Program/Event Startups API returns results, it places them within a (JSON) teams[] array.

A typical result is made up of the following fields:

The teams[] is an array containing the separate team objects. Each team[] typically contains:

  • id - integer, is the startup profile id.
  • name - string, is the startup name as shown in the startup profile URL.
  • blurb - string, is the shrot startup description.
  • description - string, is the full startup description.
  • url - string, is the full startup profile URL.
  • thumbnail[] contains all the information about the startup profile picture. It is an array containing the separate thumbnail objects. The array typically contains:
    • url is a string that displays the full URL of deal thumbnail with the selected size.
    • image_id - string, is the id of an image.
    • path - string, is the path part of URL to image folder.
    • type - string, is the file extension of an image (jpg,png,gif)
    • size - string, is the name of the re-sized image thumbnail. To see all the available sizes, check the thumbnail sizes section below.
    • mime_type is the mime type of the file.
    • width - integer, is the width in pixels of current re-sized copy of original image.
    • height - integer, is the height in pixels of current re-sized copy of original image.
  • links[] is an array of Link objects. It contains all the links that you find on the startup profile page. Each Link object typically contains:
    • type - string, is type of the link. The following values are currently supported:
      • facebook
      • linkedin
      • twitter
      • android
      • website
      • googleplus
    • value - string, is the full URL of the link.
  • skills[] is an array of Skill objects. It contains the skills that the startup has listed on their profile page.
  • members[] is an array of Profile (basic) objects. List of team members
  • mentors[] is an array that contains basic information of the mentor profiles associated with the startup. Each mentor object typically contains:
    • id - integer, is the mentor profile ID.
    • name - string, is the mentor profile name.
    • url - string, is the full URL of the mentor profile.
    • thumbnail[] - array, it contains the information about the mentor profile picture.
  • belongs_to_profile[] is an array of Profile objects. It references the Program profile that the Startup is related to.
Note: belongs_to_profile[] is used when a Startup is returned from a profile that is below the profile being called hierarchically. For example, when the API is used to call Profile A, which has Profile B as a child profile that Team C is attached to, your API call for Profile A will include a return with Team C with Profile B as the belongs_to_profile.

Profile Connections API

Overview

The Profile Connections API lets you get the F6S data of all the people associated with a set profile. The API call returns a JSON array based on URL parameters sent through a standard HTTP request.

Note: The Profile Connections API doesn't return Mentors. It only returns: members, leaders, investors, applicants, following and followers.
To access the Mentors that are associated with a profile, please see the Mentor Profile API.

Profile Connections API request format

A Profile Connections API request takes the following form:

https://api.f6s.com/PROFILE-NAME/CONNECTION?api_key=API-KEY

Where:

  • PROFILE-NAME is either the profile’s alias or actor-id.

  • CONNECTION is one of the following values:
    • members returns the members of the requested profile,
    • leaders returns the leaders of the profile,
    • investors returns the investors related to the profile,
    • applicants returns the applicants to the profile (in case it's a program),
    • following returns who the profile is following,
    • followers returns the followers of the profile.

Example: requesting information about the followers of the profile "Startup X"

The following example contains the URL of a JSON that contains the connectins of the profile of GreatStartup. As shown in the profile URL https://www.f6s.com/startupx, the profile alias is startupx, so the URL to call the API is:

https://api.f6s.com/greatstartup/followers?api_key=XXXXXX

When you send through this HTTPS request, the API returns a JSON like the following:

{
   "followers":[
      {
         "id":"216329",
         "name":"Mick One",
         "description":"True believer in Innovation, strategy and market driven approach",
         "url":"https:\/\/www.f6s.com\/mickone",
         "company_name":"",
         "thumbnail":{
            "url":"https:\/\/1db44f7c4e39b2d86e7e-677cd5270e70f156b5d14a00d2ed7d35.ssl.cf1.rackcdn.com\/1234\/123456_th1.jpg",
            "image_id":"123456",
            "path":"pictures\/profiles\/32\/1234",
            "type":"jpg",
            "size":"th1",
            "mime_type":"image\/jpeg",
            "width":140,
            "height":140
         },
         "skills":[
            {
               "id":"341",
               "name":"Team Building"
            },
            {
               "id":"2061",
               "name":"Strategic Planning"
            },
            {
               "id":"846",
               "name":"User Experience"
            }
         ],
         "links":[
            {
               "type":"facebook",
               "value":"https:\/\/www.facebook.com\/mick.one.79230"
            },
            {
               "type":"linkedin",
               "value":"https:\/\/in.linkedin.com\/pub\/mick-one\/24\/868\/b0a\/"
            }
         ],
         "belongs_to_profile":[
            {
               "id":"210894",
               "name":"GreatStartup",
               "url":"https:\/\/www.f6s.com\/startupx",
               "thumbnail":{
                  "url":"https:\/\/1db44f7c4e39b2d86e7e-677cd5270e70f156b5d14a00d2ed7d35.ssl.cf1.rackcdn.com\/1234\/12345_th1.jpg",
                  "image_id":"12345",
                  "path":"pictures\/profiles\/32\/1234",
                  "type":"jpg",
                  "size":"th1",
                  "mime_type":"image\/jpeg",
                  "width":140,
                  "height":140
               }
            }
         ],
         "mentor_of":[
         ]
      }
   ],
   "status":200,
   "error":{
      "error_code":0
   }
}

Profile Connections API results

When the Profile Connections API returns results, it places them within a (JSON)array.

A typical result is made up of the following fields:

  • id - integer, is the id of the profile connection.
  • name - string, is the profile connection name.
  • description - string, is the full description of the profile connection.
  • url - string, is the full URL of the profile connection.
  • company_name - string, is the name of the current workplace (if person).
  • thumbnail contains all the information about the profile connection picture. It is an array containing the separate thumbnail objects. The array typically contains:
    • url is a string that displays the full URL of deal thumbnail with the selected size.
    • image_id - string, is the id of an image.
    • path - string, is the path part of URL to image folder.
    • type - string, is the file extension of an image (jpg,png,gif)
    • size - string, is the name of the re-sized image thumbnail. To see all the available sizes, check the thumbnail sizes section below.
    • mime_type is the mime type of the file.
    • width - integer, is the width in pixels of current re-sized copy of original image.
    • height - integer, is the height in pixels of current re-sized copy of original image.
  • links[] is an array of Link objects. It contains all the links that you find on the profile connection page. Each Link object typically contains:
    • type - string, is type of the link. The following values are currently supported:
      • facebook
      • linkedin
      • twitter
      • android
      • website
      • googleplus
    • value - string, is the full URL of the link.
  • belongs_to_profile[] is an array of Profile objects. It references the parent profile that the object is related to.
Note: belongs_to_profile[] is used when an object is returned from a profile that is below the profile being called hierarchically. For example, when the API is used to call Profile A, which has Profile B as a child profile that Team C is attached to, your API call for Profile A will include a return with Team C with Profile B as the belongs_to_profile.
  • mentor_of[] is array of basic Profile objects. It contains a list of the mentors related to the profile.

Profile Hierarchy API

Overview

The Profile Hierarchy API lets you get the structure of all profiles located below a requested profile, if any. The Profile Hierarchy API call returns a JSON array based on URL parameters sent through a standard HTTPS request

Profile Hierarchy API request format

A request takes the following form:

https://api.f6s.com/PROFILE-NAME/branch?api_key=API-KEY

Where:

  • PROFILE-NAME is either the profile’s alias or actor-id.

Example: requesting sub-profiles of the profile "Sample Profile"

The following example contains the URL of a JSON with the hierarchy of profiles below "Sample Profile". As shown in the URL https://www.f6s.com/sampleprofile, the profile alias is sampleprofile, so the URL to call the API is:

https://api.f6s.com/sampleprofile/branch?api_key=XXXXXX

When you send through this HTTPS request, the API returns JSON as follows:

{
   "data":{
      "id":"547784",
      "name":"Sample Profile",
      "date_created":"2016-04-06 12:38:25",
      "url":"http:\/\/www.cloudaccelerator.com\/sampleprofile",
      "children":[
         {
            "id":"547785",
            "name":"Event Profile 1",
            "date_created":"2016-04-06 12:38:50",
            "url":"http:\/\/www.cloudaccelerator.com\/eventprofile1",
            "children":[
               {
                  "id":"547787",
                  "name":"Fund Profile 1",
                  "date_created":"2016-04-06 12:39:55",
                  "url":"http:\/\/www.cloudaccelerator.com\/fundprofile1",
                  "children":[

                  ]
               },
               {
                  "id":"547786",
                  "name":"Accelerator Profile 1",
                  "date_created":"2016-04-06 12:39:24",
                  "url":"http:\/\/www.cloudaccelerator.com\/acceleratorprofile1",
                  "children":[

                  ]
               }
            ]
         },
         {
            "id":"547788",
            "name":"Contest Profile 1",
            "date_created":"2016-04-06 12:40:35",
            "url":"http:\/\/www.cloudaccelerator.com\/contestprofile1",
            "children":[

            ]
         }
      ]
   },
   "status":200,
   "error":{
      "error_code":0
   }
}

Profile Hierarchy API results

Profile Hierarchy API results are returned in a JSON array.

A typical result is made up of the following fields:

  • id - integer, the id of the profile.
  • name - string, the profile name.
  • date_created - string, date and time when profile was created.
  • url - string, the full URL of the profile.
  • children - array, list of direct sub-profile objects where each has id, name, url and children.

Program Applications API

Overview

The Program Applications API lets you get the F6S data of the applications associated with an organisation or program profile. The API call returns a JSON array based on URL parameters sent through a standard HTTPS request.

Program Applications API request format

A Program Applications API request takes the following form:

https://api.f6s.com/PROFILE-NAME/applications?api_key=API-KEY&sort_by=ORDER&count=ITEMS-PER-PAGE&page=CURRENT-PAGE&application_id=APPLICATION-ID

Where:

  • PROFILE-NAME is either the profile’s alias or actor-id

  • ORDER (optional) can be either newest or oldest and sets the order in which to retrieve the applications.

  • ITEMS-PER-PAGE (optional) is the maximum number of Applications objects displayed per page. Default is 10.

  • CURRENT-PAGE (optional) is the page in pagination [1,2,3,…] where to make the request. Default is 1.

  • APPLICATION-ID (optional) is the number of an application. It offers the ability to reference an individual application.

Example: To retrieve the APPLICATION-ID, go to your Dashboard and select an application that applied to your program. The url in the address bar will look similar to this: https://www.f6s.com/#account/accelerators/ajax-applicant-evaluation/1234/567890/?anchor_prefix=&container=home&lpos=0
In this case, the APPLICATION-ID would be 567890, the second number in the url.

Example: requesting information about the applications to the program “Startup Program 2014”

The following example contains the URL of a JSON that contains the information about the applications for Startup Program 2014, whose URL is https://www.f6s.com/startupprogram2014. The PROFILE-NAME is then startupprogram2014, and the URL for the API call is:

https://api.f6s.com/startupprogram2014/applications?api_key=XXXXXX

When you send through this HTTPS request, the API returns a JSON like the following:

{
   "data":[
      {
         "id":"12345",
         "rating":"0.00000",
         "email":"applicant@email.it",
         "date_created":"2014-10-10 20:49:03",
         "date_finalized":"2014-10-10 23:26:27",
         "date_updated":"2014-10-10 23:26:27",
         "profile_id":"331161",
         "name":"Applicant Name",
         "status":"Finalized",
         "location":{
            "city":"Florence",
            "country":"Italy"
         },
         "thumbnail":{
            "url":"https:\/\/cfb5072d660efed5c16f-bb33dcaa509bc5fe502dd6506d4e69fb.ssl.cf1.rackcdn.com\/4565\/456474_th1.jpg",
            "image_id":"456474",
            "path":"pictures\/profiles\/46\/4565",
            "type":"jpg",
            "size":"th1",
            "mime_type":"image\/jpeg",
            "width":140,
            "height":140
         },
         "tags":[
            {
               "id":"153",
               "name":"Financial Analysis"
            },
            {
               "id":"341",
               "name":"Team Building"
            }
         ],
         "evaluation":{
            "categories":[
               {
                  "custom_category_id":"1876",
                  "custom_category_name":"English Level",
                  "accelerator_id":"11008"
               }
            ],
            "evaluators":[
               {
                  "id":"6879",
                  "name":"Rose Jeantet",
                  "rating":[
                     {
                        "category_id":"1875",
                        "rating_value":""
                     },
                     {
                        "category_id":"1876",
                        "rating_value":""
                     },
                     {
                        "category_id":"1877",
                        "rating_value":""
                     }
                  ]
               }
            ]
         },
         "questions":[
            {
               "id":"211551",
               "name_attribute":"lcljvlt-kbbnxso",
               "type":"text",
               "caption":"Your Skype ID is:",
               "description":"If you get selected, you will be interviewed via skype.\nIf you don't have a skype ID, please enter your Gmail email address for Google Hangout.",
               "required":1,
               "question_response":""
            }
         ]
      }
   ],
   "status":200,
   "items_count":10,
   "total_items_count":19,
   "next":"https:\/\/api.f6s.com\/startupprogram2014\/applications?api_key=XXXXXX&page=2",
   "error":{
      "error_code":0
   }
}

Program Applications API results

When the Program Applications API returns results, it places them within a (JSON) array.

A typical result is made up of the following fields:

The data[] is an array containing the separate Data objects. Each data element is an application to a program and it typically contains:

  • id - integer, is the application id.
  • rating - string, is the applicant average rating.
  • date_created - date, is the date when the application was created.
  • date_finalized - date, is the date when the application was finalized.
  • date_updated - date, is the date of last update.
  • profile_id - integer, is the applicant profile id. It can refer to either a person or a startup.
  • presentation - string, is the applicant name. It can refer to either a person or a startup.
  • status - string, is the status of the application. It displays one of the following values:
    • In Progress
    • Accepted
    • Rejected
    • Extend Offer
    • Finalized
  • location[] - array, shows the information about the location of the applicant. It typically contains:
    • city - string, is the name of the city.
    • country - string, is the name of the country.
  • members[] - array, is the list of application team members (if any). It typically contains:
    • brief_description - string, is a short description of the team member.
    • email - string, is the email address of the team member.
    • skills - array, is a list of Skill objects that contains the team member skills.
    • links - array, is a list of Link objects, that contains the list of links shown on the team member profiles.
  • evaluation[] - array, shows information about applications evaluation. Typically, an evaluation[] array contains:
    • categories[] - array, is a list of program evaluation categories.
    • evaluators[] - array, is a list of program evaluators. Typically it contains:
      • id - integer, is the id of evaluator profile
      • name - string, is the name of evaluator
      • rating - float, is the rating that the evaluator has given to current application.
Note: In case the application has one or more rating categories, the Category Rating Object array is shown and contains: - category_id - id of category,
- rating_value - rating on current category (float),
- default - [empty array]
  • questions[] - array, contains a list of questions. Each question[] object typically contains:
    • id - integer, is the ID of the question.
    • name_attribute - string, is the name attribute of this field
    • type - string, is the type of question. It displays one of the following values:
      • select
      • longtext
      • text
      • video
      • members_longtext
      • checkboxes
      • members_select
      • members_checkboxes
      • radion
      • file_upload
      • date
      • currency
    • caption - string, is the value of the caption text field.
    • description - string, is the description of the question (if exists.)
    • required - boolean, it shows whether the field is required (value = 1) or not (value = 0).
    • question_response - string, is the applicant answer to the question.
Note: The type of question_respone value depends on the type of question.
- If the question type is longtext, text or video, the response is a string.
- If the question type is checkboxes, the response is an array of checkbox titles.
- If the question type is select , the response is an array of selected values.
- If the question type is member_longtext, members_text, members_select, the response is an array that contains:
- `id` - integer, is the member_profile_id.
- `name` - string, is the name of who answered the question.
- `response` - string, is the response text.