Appendix

Each integration partners is assigned an API key and API secret. The pair used to sign each request. The API key is publicly visible. The API secret is private and should not be shared. Sharing your API secret could allow someone to impersonate your application and alter your user's data.

Name Optionality Description Type Length
User Required User account information.
Id Optional - Create
Required - Update
The unique identifier for the user. Required for updates. string 6
FirstName Required - Create
Optional - Update
The user's first name. Required for creates. string 64
LastName Required - Create
Optional - Update
The user's last name. Required for creates. string 64
Email Required - Create
Optional - Update
The user's email address. Required for creates. string 128
Password Optional The user's password. At least 7 characters with at least one letter and one number. string 32
ProfileUrl Returned The fully qualified url for the user's profile. string 256
Profile Optional User profile information.
Introduction Optional A brief introduction for the user. string 1,024
Biography Optional A biography for the user. string 65,536
ProfessionalSummary Optional The user's professional summary. string 65,536
Title Optional The user's title. string 128
Photo Optional Fully qualified url to the user's profile photo. string 256
Address Optional User address information.
Line1 Required The user's street address line 1. string 128
Line2 Optional The user's street address line 2. string 128
Line3 Optional The user's street address line 3. string 128
City Required The user's address city. string 128
State Optional The user's address state. May be required for some countries. string 2
PostalCode Optional The user's address postal code. May be required for some countries. string 16
Country Required The user's address country. string 2
PhoneNumber Optional User phone number information. Multiple entries permitted. Update will only add new entries.
PhoneNumberType Required The phone number type. Valid phone number types. int
Label Optional A user friendly label for the phone number. string 64
Number Required The phone number. string 32
Website Optional User website information. Multiple entries permitted. Update will only add new entries.
Label Optional A user friendly label for the website. string 128
Url Required A fully qualified url. string 256
Link Optional User website information. Multiple entries permitted. Update will only add new entries.
ServiceId Required The service id for the link. Valid service ids. int
Label Optional A user friendly label for the link. string 64
Url Required A fully qualified url. string 512
Messenger Optional User website information. Multiple entries permitted. Update will only add new entries.
MessengerId Required The messenger id for the chat/messenger service. Valid Valid messenger ids. int
ScreenName Required The screen name for the chat/messenger service. string 256
Employment Optional User employment information. Multiple entries permitted. Update will only add new entries.
Employer Required The user's employer. string 64
IndustryId Optional The industry id for the user's employer. Defaults to "Other". Valid industry ids. int
Position Optional The user's position for the employer. string 128
Description Optional A description of the user's responsibilities in the position. string 65,536
StartMonth Optional The month the user started with the employer. Valid values 1 to 12. int
StartYear Optional The year the user started with the employer. Valid values 1900 to 9999. int
EndMonth Optional The month the user ended with the employer. Valid values 1 to 12. int
EndYear Optional The year the user ended with the employer. Valid values 1900 to 9999. int
Url Optional A fully qualified url for the employer. string
Education Optional User education information. Multiple entries permitted. Update will only add new entries.
School Required The name of the school attended. string 128
Degree Optional The degree earned or expected. string 64
FieldOfStudy Optional The field of study for the degree. string 64
Description Optional A description of the activities, sports, clubs, honors, etc. string 65,536
StartYear Optional The year the user started at the school. Valid values 1900 to 9999. int
EndYear Optional The year the user ended at the school. Valid values 1900 to 9999. int