Users

/v1/users

Returns an array of compact user objects, according to default record offset and limit.

Parameters

  • limit - refers to the number of records returned in the request.

  • offset - refers to the record offset, for pagination purposes.

Note

  • limit is optional (defaults to 20).
  • offset is optional (defaults to 0).
  • VC4A API key authorization required.

Return Values

  • id - the unique vc4a identifier for the user.
  • firstName - the corresponding first name for the user.
  • lastName - the corresponding last name for the user.
  • displayName - the display name chosen by the user (defaults to first/last name).
  • lastActive - a timestamp representing the user's last activity.
  • metadata - offset, limit and totalCount.

Example Request

API Address: https://api.vc4a.com
GET /v1/users?offset=0&limit=5

Example Response

{
    "users": [{
        "id": "1580",
        "firstName": "Nelson",
        "lastName": "Kana",
        "displayName": "Nelson Kana",
        "lastActive": "2015-09-19 13:59:27"
    }, {
        "id": "7573",
        "firstName": "Hendrik",
        "lastName": "Admiraal",
        "displayName": "Hendrik Admiraal",
        "lastActive": "2015-09-24 08:00:32"
    }, {
        "id": "1156",
        "firstName": "Neil",
        "lastName": "deGrasse Tyson",
        "displayName": "Neil deGrasse Tyson",
        "lastActive": "2015-10-09 10:05:53"
    }, {
        "id": "9155",
        "firstName": "Nikola",
        "lastName": "Tesla",
        "displayName": "Nikola Tesla",
        "lastActive": "2015-09-24 08:01:17"
    }, {
        "id": "1",
        "firstName": "Bill",
        "lastName": "Zimmerman",
        "displayName": "Bill Zimmerman",
        "lastActive": "2015-09-27 13:02:26"
    }],
    "_metadata": [{
        "offset": "0",
        "limit": "5",
        "totalCount": 5
    }]
},
  "status_code": 200,
  "status_txt": "OK"
}

/v1/users/:user_id

Returns extended profile information for a given user and associated metadata.

Parameters

  • user_id - the unique vc4a identifier for the user.

Note

  • user_id is a required parameter.
  • VC4A API key authorization required.

Return Values

  • id - the unique vc4a identifier for the user.
  • firstName - the corresponding first name for the user.
  • lastName - the corresponding last name for the user.
  • displayName - the display name chosen by the user (defaults to first/last name).
  • lastActive - a timestamp representing the user's last activity.
  • title - the corresponding title for the user.
  • organization - the corresponding organization for the user.
  • city - the city where the user is located.
  • country - the country where the user is located.

Example Request

API Address: https://api.vc4a.com
GET /v1/users/1580

Example Response

{
    "user": [{
        "id": "1580",
        "firstName": "Nelson",
        "lastName": "Kana",
        "lastActive": "2012-09-19 13:59:27",
        "title": "Head of Ecosystem",
        "organization": "Zinger Systems",
        "city": "Buea",
        "country": "Cameroon"
    }]
},
  "status_code": 200,
  "status_txt": "OK"
}

/v1/users/:user_id/ventures

Returns a compact array of ventures for a given user.

Parameters

  • user_id - the unique vc4a identifier for the user.

Note

  • user_id is a required parameter.
  • VC4A API key authorization required.

Return Values

  • id - the unique vc4a identifier for the venture.
  • name - the corresponding name of the venture.
  • sectors - the primary sector(s) the ventures is engaged in.
  • tags - a comma-delimited list of tags for the venture.
  • fundStatus - the corresponding fundraising status for the venture.
  • country - the primary country where the venture is based.
  • latitude - the north-south distance from the equator, expressed in degrees and minutes.
  • longitude - the east-west distance from the meridian, expressed in degrees and minutes.

Example Request

API Address: https://api.vc4a.com
GET /v1/users/1/ventures.json

Example Response

[{
    "user": {
        "id": "9",
        "name": "Miniature Vancouver",
        "sectors": "Electronics,Leisure",
        "tags": "video,documentary,entertainment,cities",
        "fundStatus": "Raising Capital",
        "country": "Ethiopia",
        "latitude": "4.287556427760489",
        "longitude": "10.689018062500054"
    }
}, {
    "user": {
        "id": "16",
        "name": "Anvil Studio",
        "sectors": "Consumer,Manufacturing",
        "tags": "widgets",
        "fundStatus": "Round Pending",
        "country": "Cameroon",
        "latitude": "4.199906782278597",
        "longitude": "11.216361812500054"
    }
}, {
    "user": {
        "id": "18",
        "name": "Space Tourism",
        "sectors": "Tourism",
        "tags": "space,rockets,zero-g",
        "fundStatus": "Seeking Investor",
        "country": "Cape Verde",
        "latitude": "15.210222837556922",
        "longitude": "-23.88184306249991"
    }
}],
  "status_code": 200,
  "status_txt": "OK"
}

/v1/users/:user_id/followers

Returns an array of compact user objects representing the followers of a given user.

Parameters

  • user_id - the unique vc4a identifier for the user.

Note

  • user_id is a required parameter.
  • VC4A API key authorization required.

Return Values

  • id - the unique vc4a identifier for the follower.
  • metadata - offset, limit and totalCount.

Example Request

API Address: https://api.vc4a.com
GET /v1/users/1/followers.json

Example Response

{
    "followers": [{
        "id": "14"
    }, {
        "id": "17"
    }, {
        "id": "24"
    }, {
        "id": "24"
    }, {
        "id": "25"
    }, {
        "id": "32"
    }, {
        "id": "37"
    }, {
        "id": "47"
    }, {
        "id": "48"
    }, {
        "id": "51"
    }, {
        "id": "104"
    }],
    "_metadata": [{
        "offset": "0",
        "limit": "20",
        "totalCount": 11
    }]
},
  "status_code": 200,
  "status_txt": "OK"
}

/v1/users/:user_id/following

Returns an array of compact user objects representing the users followed by a given user.

Parameters

  • user_id - the unique vc4a identifier for the user.

Note

  • user_id is a required parameter.
  • VC4A API key authorization required.

Return Values

  • id - the unique vc4a identifier for the user being followed.
  • metadata - offset, limit and totalCount.

Example Request

API Address: https://api.vc4a.com
GET /v1/users/1/following.json

Example Response

{
    "following": [{
        "id": "6"
    }, {
        "id": "76"
    }, {
        "id": "74"
    }, {
        "id": "43"
    }, {
        "id": "42"
    }, {
        "id": "59"
    }, {
        "id": "102"
    }, {
        "id": "17"
    }, {
        "id": "14"
    }, {
        "id": "34"
    }],
    "_metadata": [{
        "offset": "0",
        "limit": "20",
        "totalCount": 10
    }]
},
  "status_code": 200,
  "status_txt": "OK"
}

/v1/users/:user_id/activity

Returns an array of activity items for a given user.

Parameters

  • user_id - the unique vc4a identifier for the user.

Note

  • user_id is a required parameter.
  • VC4A API key authorization required.

Return Values

  • id - the unique vc4a identifier for the activity item.
  • component - the name of the component for the activity item.
  • type - the corresponding type for the activity item.
  • action - the corresponding action for the activity item.
  • content - the content of the activity item.
  • dateRecorded - a timestamp representing the time at which the activity item was recorded.
  • metadata - offset, limit and totalCount.

Example Request

API Address: https://api.vc4a.com
GET /v1/users/1/activity.json?limit=3

Example Response

{
    "0": {
        "activity": {
            "id": "147802",
            "component": "xprofile",
            "type": "profile_updated",
            "action": "User Status",
            "content": "Integer sit amet libero id est tristique fringilla.",
            "dateRecorded": "2012-12-16 11:01:22"
        }
    },
    "1": {
        "activity": {
            "id": "147803",
            "component": "xprofile",
            "type": "profile_updated",
            "action": "User Status",
            "content": "Etiam faucibus nunc vitae ipsum blandit scelerisque laoreet vel lorem.",
            "dateRecorded": "2012-12-12 19:24:11"
        }
    },
    "2": {
        "activity": {
            "id": "147804",
            "component": "xprofile",
            "type": "profile_updated",
            "action": "User Status",
            "content": ". Nulla gravida viverra urna. Aenean condimentum.",
            "dateRecorded": "2012-12-01 09:34:38"
        }
    },
    "_metadata": [{
        "offset": "0",
        "limit": "3",
        "totalCount": "2620"
    }]
},
  "status_code": 200,
  "status_txt": "OK"
}