LEAF API Documentation
You are in: API » Release 1 » Profile

Get User Profile Details GET

Gets profile details, including contact details, for the current authenticated user

Parameters

Response Parameters
ParameterNameTypeDescription
titleTitleEnumeration (Optional) 
forenameForenameString (Optional) 
surnameSurnameString (Optional) 
emailEMail AddressStringDo not include any space or punctuation
positionPositionString (Optional) 
addressAddressString (Optional) 
countyCountyString (Optional) 
postcodePostcodeString (Optional) 
countryCountryEnumeration 
phonePhoneString (Optional) 
faxFaxString (Optional) 
mobileMobileString (Optional) 

Enumerations

Title (Response)
ValueDescription
MrMr
MrsMrs
MissMiss
MsMs
DrDr
ProfProf
RevRev
LordLord
LadyLady
SirSir
Rt. HonRt. Hon
DameDame
Country (Response)
ValueDescription
Please selectPlease select
United KingdomUnited Kingdom
JerseyJersey
GuernseyGuernsey
United States of AmericaUnited States of America
AfghanistanAfghanistan
AlbaniaAlbania
AlgeriaAlgeria
American SamoaAmerican Samoa
AndorraAndorra
AngolaAngola
AnguillaAnguilla
AntarcticaAntarctica
Antigua & BarbudaAntigua & Barbuda
ArgentinaArgentina
ArmeniaArmenia
ArubaAruba
AustraliaAustralia
AustriaAustria
AzerbaijanAzerbaijan
BahamasBahamas
BahrainBahrain
BangladeshBangladesh
BarbadosBarbados
BelarusBelarus
BelgiumBelgium
BelizeBelize
BeninBenin
BermudaBermuda
BhutanBhutan
BoliviaBolivia
Bosnia and HerzegovinaBosnia and Herzegovina
BotswanaBotswana
Bouvet IslandBouvet Island
BrazilBrazil
British Indian Ocean TerritoryBritish Indian Ocean Territory
British Virgin IslandsBritish Virgin Islands
Brunei DarussalamBrunei Darussalam
BulgariaBulgaria
Burkina FasoBurkina Faso
BurundiBurundi
CambodiaCambodia
CameroonCameroon
CanadaCanada
Cape VerdeCape Verde
Cayman IslandsCayman Islands
Central African RepublicCentral African Republic
ChadChad
ChileChile
ChinaChina
Christmas IslandChristmas Island
Cocos (Keeling) IslandsCocos (Keeling) Islands
ColombiaColombia
ComorosComoros
CongoCongo
Cook IslandsCook Islands
Costa RicaCosta Rica
Côte d'IvoireCôte d'Ivoire
CroatiaCroatia
CubaCuba
CyprusCyprus
Czech RepublicCzech Republic
Demo. People's Rep. of KoreaDemo. People's Rep. of Korea
Democratic Rep. of CongoDemocratic Rep. of Congo
DenmarkDenmark
DjiboutiDjibouti
DominicaDominica
Dominican RepublicDominican Republic
East Timor (Timor-Leste)East Timor (Timor-Leste)
EcuadorEcuador
EgyptEgypt
El SalvadorEl Salvador
Equatorial GuineaEquatorial Guinea
EritreaEritrea
EstoniaEstonia
EthiopiaEthiopia
Falkland Islands (Malvinas)Falkland Islands (Malvinas)
Faroe IslandsFaroe Islands
Federated States of MicronesiaFederated States of Micronesia
FijiFiji
FinlandFinland
FranceFrance
French GuianaFrench Guiana
French PolynesiaFrench Polynesia
French Southern TerritoriesFrench Southern Territories
GabonGabon
GambiaGambia
GeorgiaGeorgia
GermanyGermany
GhanaGhana
GibraltarGibraltar
GreeceGreece
GreenlandGreenland
GrenadaGrenada
GuadeloupeGuadeloupe
GuamGuam
GuatemalaGuatemala
GuineaGuinea
Guinea-BissauGuinea-Bissau
GuyanaGuyana
HaitiHaiti
Heard and McDonald IslandsHeard and McDonald Islands
Holy See (Vatican City State)Holy See (Vatican City State)
HondurasHonduras
Hong KongHong Kong
HungaryHungary
IcelandIceland
IndiaIndia
IndonesiaIndonesia
IranIran
IraqIraq
IrelandIreland
Isle of ManIsle of Man
IsraelIsrael
ItalyItaly
JamaicaJamaica
JapanJapan
JordanJordan
KazakhstanKazakhstan
KenyaKenya
KiribatiKiribati
KuwaitKuwait
KyrgyzstanKyrgyzstan
Lao People's Democratic RepublicLao People's Democratic Republic
LatviaLatvia
LebanonLebanon
LesothoLesotho
LiberiaLiberia
Libyan Arab JamahiriyaLibyan Arab Jamahiriya
LiechtensteinLiechtenstein
LithuaniaLithuania
LuxembourgLuxembourg
MacaoMacao
MacedoniaMacedonia
MadagascarMadagascar
MalawiMalawi
MalaysiaMalaysia
MaldivesMaldives
MaliMali
MaltaMalta
Marshall IslandsMarshall Islands
MartiniqueMartinique
MauritaniaMauritania
MauritiusMauritius
MayotteMayotte
MexicoMexico
MonacoMonaco
MongoliaMongolia
MontenegroMontenegro
MontserratMontserrat
MoroccoMorocco
MozambiqueMozambique
Myanmar (ex-Burma)Myanmar (ex-Burma)
NamibiaNamibia
NauruNauru
NepalNepal
NetherlandsNetherlands
Netherlands AntillesNetherlands Antilles
New CaledoniaNew Caledonia
New ZealandNew Zealand
NicaraguaNicaragua
NigerNiger
NigeriaNigeria
NiueNiue
Norfolk IslandNorfolk Island
Northern Mariana IslandsNorthern Mariana Islands
NorwayNorway
OmanOman
PakistanPakistan
PalauPalau
Palestinian TerritoryPalestinian Territory
PanamaPanama
Papua New GuineaPapua New Guinea
ParaguayParaguay
PeruPeru
PhilippinesPhilippines
Pitcairn IslandPitcairn Island
PolandPoland
PortugalPortugal
Puerto RicoPuerto Rico
QatarQatar
Republic of MoldovaRepublic of Moldova
Republic of South KoreaRepublic of South Korea
ReunionReunion
RomaniaRomania
Russia (Russian Federation)Russia (Russian Federation)
RwandaRwanda
S. Georgia and S. Sandwich Is.S. Georgia and S. Sandwich Is.
SaharaSahara
Saint HelenaSaint Helena
Saint Kitts and NevisSaint Kitts and Nevis
Saint LuciaSaint Lucia
Saint Pierre and MiquelonSaint Pierre and Miquelon
Saint Vincent and the GrenadinesSaint Vincent and the Grenadines
SamoaSamoa
San MarinoSan Marino
Sao Tome and PrincipeSao Tome and Principe
Saudi ArabiaSaudi Arabia
SenegalSenegal
SerbiaSerbia
SeychellesSeychelles
Sierra LeoneSierra Leone
SingaporeSingapore
SlovakiaSlovakia
SloveniaSlovenia
Solomon IslandsSolomon Islands
SomaliaSomalia
South AfricaSouth Africa
SpainSpain
Sri Lanka (ex-Ceilan)Sri Lanka (ex-Ceilan)
SudanSudan
SurinameSuriname
Svalbard and Jan Mayen IslandsSvalbard and Jan Mayen Islands
SwazilandSwaziland
SwedenSweden
SwitzerlandSwitzerland
Syrian Arab RepublicSyrian Arab Republic
TaiwanTaiwan
TajikistanTajikistan
TanzaniaTanzania
ThailandThailand
Timor-Leste (East Timor)Timor-Leste (East Timor)
TogoTogo
TokelauTokelau
TongaTonga
Trinidad & TobagoTrinidad & Tobago
TunisiaTunisia
TurkeyTurkey
TurkmenistanTurkmenistan
Turks and Caicos IslandsTurks and Caicos Islands
TuvaluTuvalu
U.S.Virgin IslandsU.S.Virgin Islands
UgandaUganda
UkraineUkraine
United Arab EmiratesUnited Arab Emirates
United Republic of TanzaniaUnited Republic of Tanzania
UruguayUruguay
US Minor Outlying IslandsUS Minor Outlying Islands
UzbekistanUzbekistan
VanuatuVanuatu
VenezuelaVenezuela
Viet NamViet Nam
Wallis and FutunaWallis and Futuna
Western SaharaWestern Sahara
YemenYemen
ZambiaZambia
ZimbabweZimbabwe

XML

Example Request
GET https://api.leaf.eco/r1/profile.eb HTTP/1.1
Accept: text/xml
Response Schema
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="Profile">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="title" minOccurs="0">
          <xsd:simpleType>
            <xsd:restriction base="xsd:string">
              <xsd:enumeration value="Mr" />
              <xsd:enumeration value="Mrs" />
              <xsd:enumeration value="Miss" />
              <xsd:enumeration value="Ms" />
              <xsd:enumeration value="Dr" />
              <xsd:enumeration value="Prof" />
              <xsd:enumeration value="Rev" />
              <xsd:enumeration value="Lord" />
              <xsd:enumeration value="Lady" />
              <xsd:enumeration value="Sir" />
              <xsd:enumeration value="Rt. Hon" />
              <xsd:enumeration value="Dame" />
            </xsd:restriction>
          </xsd:simpleType>
        </xsd:element>
        <xsd:element name="forename" minOccurs="0" type="xsd:string" />
        <xsd:element name="surname" minOccurs="0" type="xsd:string" />
        <xsd:element name="email" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>Do not include any space or punctuation
</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="position" minOccurs="0" type="xsd:string" />
        <xsd:element name="address" minOccurs="0" type="xsd:string" />
        <xsd:element name="county" minOccurs="0" type="xsd:string" />
        <xsd:element name="postcode" minOccurs="0" type="xsd:string" />
        <xsd:element name="country">
          <xsd:simpleType>
            <xsd:restriction base="xsd:string">
              <xsd:enumeration value="Please select" />
              <xsd:enumeration value="United Kingdom" />
              <xsd:enumeration value="Jersey" />
              <xsd:enumeration value="Guernsey" />
              <xsd:enumeration value="United States of America" />
              <xsd:enumeration value="Afghanistan" />
              <xsd:enumeration value="Albania" />
              <xsd:enumeration value="Algeria" />
              <xsd:enumeration value="American Samoa" />
              <xsd:enumeration value="Andorra" />
              <xsd:enumeration value="Angola" />
              <xsd:enumeration value="Anguilla" />
              <xsd:enumeration value="Antarctica" />
              <xsd:enumeration value="Antigua &amp; Barbuda" />
              <xsd:enumeration value="Argentina" />
              <xsd:enumeration value="Armenia" />
              <xsd:enumeration value="Aruba" />
              <xsd:enumeration value="Australia" />
              <xsd:enumeration value="Austria" />
              <xsd:enumeration value="Azerbaijan" />
              <xsd:enumeration value="Bahamas" />
              <xsd:enumeration value="Bahrain" />
              <xsd:enumeration value="Bangladesh" />
              <xsd:enumeration value="Barbados" />
              <xsd:enumeration value="Belarus" />
              <xsd:enumeration value="Belgium" />
              <xsd:enumeration value="Belize" />
              <xsd:enumeration value="Benin" />
              <xsd:enumeration value="Bermuda" />
              <xsd:enumeration value="Bhutan" />
              <xsd:enumeration value="Bolivia" />
              <xsd:enumeration value="Bosnia and Herzegovina" />
              <xsd:enumeration value="Botswana" />
              <xsd:enumeration value="Bouvet Island" />
              <xsd:enumeration value="Brazil" />
              <xsd:enumeration value="British Indian Ocean Territory" />
              <xsd:enumeration value="British Virgin Islands" />
              <xsd:enumeration value="Brunei Darussalam" />
              <xsd:enumeration value="Bulgaria" />
              <xsd:enumeration value="Burkina Faso" />
              <xsd:enumeration value="Burundi" />
              <xsd:enumeration value="Cambodia" />
              <xsd:enumeration value="Cameroon" />
              <xsd:enumeration value="Canada" />
              <xsd:enumeration value="Cape Verde" />
              <xsd:enumeration value="Cayman Islands" />
              <xsd:enumeration value="Central African Republic" />
              <xsd:enumeration value="Chad" />
              <xsd:enumeration value="Chile" />
              <xsd:enumeration value="China" />
              <xsd:enumeration value="Christmas Island" />
              <xsd:enumeration value="Cocos (Keeling) Islands" />
              <xsd:enumeration value="Colombia" />
              <xsd:enumeration value="Comoros" />
              <xsd:enumeration value="Congo" />
              <xsd:enumeration value="Cook Islands" />
              <xsd:enumeration value="Costa Rica" />
              <xsd:enumeration value="Côte d'Ivoire" />
              <xsd:enumeration value="Croatia" />
              <xsd:enumeration value="Cuba" />
              <xsd:enumeration value="Cyprus" />
              <xsd:enumeration value="Czech Republic" />
              <xsd:enumeration value="Demo. People's Rep. of Korea" />
              <xsd:enumeration value="Democratic Rep. of Congo" />
              <xsd:enumeration value="Denmark" />
              <xsd:enumeration value="Djibouti" />
              <xsd:enumeration value="Dominica" />
              <xsd:enumeration value="Dominican Republic" />
              <xsd:enumeration value="East Timor (Timor-Leste)" />
              <xsd:enumeration value="Ecuador" />
              <xsd:enumeration value="Egypt" />
              <xsd:enumeration value="El Salvador" />
              <xsd:enumeration value="Equatorial Guinea" />
              <xsd:enumeration value="Eritrea" />
              <xsd:enumeration value="Estonia" />
              <xsd:enumeration value="Ethiopia" />
              <xsd:enumeration value="Falkland Islands (Malvinas)" />
              <xsd:enumeration value="Faroe Islands" />
              <xsd:enumeration value="Federated States of Micronesia" />
              <xsd:enumeration value="Fiji" />
              <xsd:enumeration value="Finland" />
              <xsd:enumeration value="France" />
              <xsd:enumeration value="French Guiana" />
              <xsd:enumeration value="French Polynesia" />
              <xsd:enumeration value="French Southern Territories" />
              <xsd:enumeration value="Gabon" />
              <xsd:enumeration value="Gambia" />
              <xsd:enumeration value="Georgia" />
              <xsd:enumeration value="Germany" />
              <xsd:enumeration value="Ghana" />
              <xsd:enumeration value="Gibraltar" />
              <xsd:enumeration value="Greece" />
              <xsd:enumeration value="Greenland" />
              <xsd:enumeration value="Grenada" />
              <xsd:enumeration value="Guadeloupe" />
              <xsd:enumeration value="Guam" />
              <xsd:enumeration value="Guatemala" />
              <xsd:enumeration value="Guinea" />
              <xsd:enumeration value="Guinea-Bissau" />
              <xsd:enumeration value="Guyana" />
              <xsd:enumeration value="Haiti" />
              <xsd:enumeration value="Heard and McDonald Islands" />
              <xsd:enumeration value="Holy See (Vatican City State)" />
              <xsd:enumeration value="Honduras" />
              <xsd:enumeration value="Hong Kong" />
              <xsd:enumeration value="Hungary" />
              <xsd:enumeration value="Iceland" />
              <xsd:enumeration value="India" />
              <xsd:enumeration value="Indonesia" />
              <xsd:enumeration value="Iran" />
              <xsd:enumeration value="Iraq" />
              <xsd:enumeration value="Ireland" />
              <xsd:enumeration value="Isle of Man" />
              <xsd:enumeration value="Israel" />
              <xsd:enumeration value="Italy" />
              <xsd:enumeration value="Jamaica" />
              <xsd:enumeration value="Japan" />
              <xsd:enumeration value="Jordan" />
              <xsd:enumeration value="Kazakhstan" />
              <xsd:enumeration value="Kenya" />
              <xsd:enumeration value="Kiribati" />
              <xsd:enumeration value="Kuwait" />
              <xsd:enumeration value="Kyrgyzstan" />
              <xsd:enumeration value="Lao People's Democratic Republic" />
              <xsd:enumeration value="Latvia" />
              <xsd:enumeration value="Lebanon" />
              <xsd:enumeration value="Lesotho" />
              <xsd:enumeration value="Liberia" />
              <xsd:enumeration value="Libyan Arab Jamahiriya" />
              <xsd:enumeration value="Liechtenstein" />
              <xsd:enumeration value="Lithuania" />
              <xsd:enumeration value="Luxembourg" />
              <xsd:enumeration value="Macao" />
              <xsd:enumeration value="Macedonia" />
              <xsd:enumeration value="Madagascar" />
              <xsd:enumeration value="Malawi" />
              <xsd:enumeration value="Malaysia" />
              <xsd:enumeration value="Maldives" />
              <xsd:enumeration value="Mali" />
              <xsd:enumeration value="Malta" />
              <xsd:enumeration value="Marshall Islands" />
              <xsd:enumeration value="Martinique" />
              <xsd:enumeration value="Mauritania" />
              <xsd:enumeration value="Mauritius" />
              <xsd:enumeration value="Mayotte" />
              <xsd:enumeration value="Mexico" />
              <xsd:enumeration value="Monaco" />
              <xsd:enumeration value="Mongolia" />
              <xsd:enumeration value="Montenegro" />
              <xsd:enumeration value="Montserrat" />
              <xsd:enumeration value="Morocco" />
              <xsd:enumeration value="Mozambique" />
              <xsd:enumeration value="Myanmar (ex-Burma)" />
              <xsd:enumeration value="Namibia" />
              <xsd:enumeration value="Nauru" />
              <xsd:enumeration value="Nepal" />
              <xsd:enumeration value="Netherlands" />
              <xsd:enumeration value="Netherlands Antilles" />
              <xsd:enumeration value="New Caledonia" />
              <xsd:enumeration value="New Zealand" />
              <xsd:enumeration value="Nicaragua" />
              <xsd:enumeration value="Niger" />
              <xsd:enumeration value="Nigeria" />
              <xsd:enumeration value="Niue" />
              <xsd:enumeration value="Norfolk Island" />
              <xsd:enumeration value="Northern Mariana Islands" />
              <xsd:enumeration value="Norway" />
              <xsd:enumeration value="Oman" />
              <xsd:enumeration value="Pakistan" />
              <xsd:enumeration value="Palau" />
              <xsd:enumeration value="Palestinian Territory" />
              <xsd:enumeration value="Panama" />
              <xsd:enumeration value="Papua New Guinea" />
              <xsd:enumeration value="Paraguay" />
              <xsd:enumeration value="Peru" />
              <xsd:enumeration value="Philippines" />
              <xsd:enumeration value="Pitcairn Island" />
              <xsd:enumeration value="Poland" />
              <xsd:enumeration value="Portugal" />
              <xsd:enumeration value="Puerto Rico" />
              <xsd:enumeration value="Qatar" />
              <xsd:enumeration value="Republic of Moldova" />
              <xsd:enumeration value="Republic of South Korea" />
              <xsd:enumeration value="Reunion" />
              <xsd:enumeration value="Romania" />
              <xsd:enumeration value="Russia (Russian Federation)" />
              <xsd:enumeration value="Rwanda" />
              <xsd:enumeration value="S. Georgia and S. Sandwich Is." />
              <xsd:enumeration value="Sahara" />
              <xsd:enumeration value="Saint Helena" />
              <xsd:enumeration value="Saint Kitts and Nevis" />
              <xsd:enumeration value="Saint Lucia" />
              <xsd:enumeration value="Saint Pierre and Miquelon" />
              <xsd:enumeration value="Saint Vincent and the Grenadines" />
              <xsd:enumeration value="Samoa" />
              <xsd:enumeration value="San Marino" />
              <xsd:enumeration value="Sao Tome and Principe" />
              <xsd:enumeration value="Saudi Arabia" />
              <xsd:enumeration value="Senegal" />
              <xsd:enumeration value="Serbia" />
              <xsd:enumeration value="Seychelles" />
              <xsd:enumeration value="Sierra Leone" />
              <xsd:enumeration value="Singapore" />
              <xsd:enumeration value="Slovakia" />
              <xsd:enumeration value="Slovenia" />
              <xsd:enumeration value="Solomon Islands" />
              <xsd:enumeration value="Somalia" />
              <xsd:enumeration value="South Africa" />
              <xsd:enumeration value="Spain" />
              <xsd:enumeration value="Sri Lanka (ex-Ceilan)" />
              <xsd:enumeration value="Sudan" />
              <xsd:enumeration value="Suriname" />
              <xsd:enumeration value="Svalbard and Jan Mayen Islands" />
              <xsd:enumeration value="Swaziland" />
              <xsd:enumeration value="Sweden" />
              <xsd:enumeration value="Switzerland" />
              <xsd:enumeration value="Syrian Arab Republic" />
              <xsd:enumeration value="Taiwan" />
              <xsd:enumeration value="Tajikistan" />
              <xsd:enumeration value="Tanzania" />
              <xsd:enumeration value="Thailand" />
              <xsd:enumeration value="Timor-Leste (East Timor)" />
              <xsd:enumeration value="Togo" />
              <xsd:enumeration value="Tokelau" />
              <xsd:enumeration value="Tonga" />
              <xsd:enumeration value="Trinidad &amp; Tobago" />
              <xsd:enumeration value="Tunisia" />
              <xsd:enumeration value="Turkey" />
              <xsd:enumeration value="Turkmenistan" />
              <xsd:enumeration value="Turks and Caicos Islands" />
              <xsd:enumeration value="Tuvalu" />
              <xsd:enumeration value="U.S.Virgin Islands" />
              <xsd:enumeration value="Uganda" />
              <xsd:enumeration value="Ukraine" />
              <xsd:enumeration value="United Arab Emirates" />
              <xsd:enumeration value="United Republic of Tanzania" />
              <xsd:enumeration value="Uruguay" />
              <xsd:enumeration value="US Minor Outlying Islands" />
              <xsd:enumeration value="Uzbekistan" />
              <xsd:enumeration value="Vanuatu" />
              <xsd:enumeration value="Venezuela" />
              <xsd:enumeration value="Viet Nam" />
              <xsd:enumeration value="Wallis and Futuna" />
              <xsd:enumeration value="Western Sahara" />
              <xsd:enumeration value="Yemen" />
              <xsd:enumeration value="Zambia" />
              <xsd:enumeration value="Zimbabwe" />
            </xsd:restriction>
          </xsd:simpleType>
        </xsd:element>
        <xsd:element name="phone" minOccurs="0" type="xsd:string" />
        <xsd:element name="fax" minOccurs="0" type="xsd:string" />
        <xsd:element name="mobile" minOccurs="0" type="xsd:string" />
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<Profile>
  <title>xsd:string</title>
  <forename>xsd:string</forename>
  <surname>xsd:string</surname>
  <email>xsd:string</email>
  <position>xsd:string</position>
  <address>xsd:string</address>
  <county>xsd:string</county>
  <postcode>xsd:string</postcode>
  <country>xsd:string</country>
  <phone>xsd:string</phone>
  <fax>xsd:string</fax>
  <mobile>xsd:string</mobile>
</Profile>

JSON

Example Request
GET https://api.leaf.eco/r1/profile.eb HTTP/1.1
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json

{"title":String,
  "forename":String,
  "surname":String,
  "email":String,
  "position":String,
  "address":String,
  "county":String,
  "postcode":String,
  "country":String,
  "phone":String,
  "fax":String,
  "mobile":String}

Test