API Reference‎ > ‎People Service‎ > ‎

Resource: `person`

Information on a person.

Schema

{
  "_type": "person",
  "criminalCheck": {string},
  "email": {string},
  "photoLastUpdatedDate": {date},
  "photoUrl": {string},
  "sexualOffenderCheck": {string},
  "username": {string},
  "showPublicPhoto": {boolean},
  "showInSearch": {boolean},
  "notificationSettings": {
    "inviteAccepted": {boolean},
    "profileRequestReceived": {boolean},
    "sharedProfileView": {boolean}
  },
  "stats": {
    "monthlyBadgeViewCount": {number},
    "monthlySearchViewCount": {number},
    "monthlyRequestCount": {number},
    "monthlySharedViewCount": {number},
    "monthlyPublicViewCount": {number},
    "badgeViewCount": {number},
    "searchViewCount": {number},
    "requestCount": {number},
    "sharedViewCount": {number},
    "publicViewCount": {number},
    "totalViewCount": {number}
  },
  "preferredName": {
    "first": {string},
    "last": {string},
    "full": {string}
  },
  "name": {
    "first": {string},
    "middle": {string},
    "last": {string},
    "suffix": {string},
    "short": {string},
    "full": {string}
  },
  "emailVerified": {boolean},
  "creationDate": {date},
  "status": {string},
  "linkedinProfile": {object},
  "googleProfile": {object},
  "twitterProfile": {object},
  "facebookProfile": {object},
  "displayName": {string},
  "profileUrl": {string},
  "isActive": {boolean},
  "id": {string},
  "badgeUrls": {
    "reppIdentityCard": {string},
    "reppIdentityLarge": {string},
    "reppIdentityMedium": {string},
    "reppIdentitySmall": {string},
    "reppLogo": {string}
  },
  "_links": {object},
  "_actions": {object}
}

Links

Rel Description
self Link to the current resource.
home Link back to the root of the people api.
authorizations Link to authorizations associated with the person.
idVerification Link to the id verification associated with the person.
criminalCheck Link to the criminal check associated with the person.
invites Link to invites associated with the person.
requests Link to the requests associated with the person.
sexualOffenderCheck Link to the sexual offender check associated with the person.
shares Link to the shares associated with the person.

Actions

Global Request Parameters

These request parameters apply to all actions on this resource.

Parameter Type Location Required Description
username string path yes Username of the person.

Action: get

Get information about the current user

Request Parameters
Parameter Type Location Required Description
embed string query no Specifies which links should be embedded instead of linked
Options: idVerification, criminalCheck, sexualOffenderCheck
fields string query no Specifies what fields of the object should be returned
Response

If successful, a person resource will be returned in the response body.


Action: put

Updates the person.

Request

A person resource is expected in the request body.

Response

If successful, a person resource will be returned in the response body.


Action: patch

Performs a partial update on a person.

Request

A person resource is expected in the request body.

Response

If successful, a person resource will be returned in the response body.


Action: delete

Delete a person.

Response

Empty response


Action: uploadPhoto

Uploads a new profile photo for the user.

Request Parameters
Parameter Type Location Required Description
photo file body no New profile photo.
Response
{
  success: {boolean},
  photoUrl: {string}
}

Action: importPhoto

Imports a profile photo from another service.

Request Parameters
Parameter Type Location Required Description
service string body no Name of the service to import the photo from
Options: linkedin
Response
{
  success: {boolean},
  photoUrl: {string}
}

Action: sendEmailVerification

Sends a verification email to the person.

Response
{
  success: {boolean}
}

Action: incrementPublicViewCount

Increment public view count

Response
{
  success: {boolean}
}

Comments